Skip to content

Commit 38b6b35

Browse files
authored
Update documents (#35)
1 parent 7f92ca2 commit 38b6b35

File tree

9 files changed

+25
-32
lines changed

9 files changed

+25
-32
lines changed

constants.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -403,11 +403,11 @@ <h3 class="const" id="ClassType">ClassType</h3>
403403
<h3 class="const" id="ColorspaceType">ColorspaceType</h3>
404404

405405
<p class="imquote">
406-
Specify the colorspace that quantization (color reduction and mapping) is done under or to specify the colorspace when encoding an output image.
407-
Color spaces are ways of describing colors to fit the requirements of a particular application (e.g. Television, offset printing, color monitors).&nbsp;
408-
Color reduction, by default, takes place in the RGBColorspace. Empirical evidence suggests that distances in color spaces such as YUVColorspace or
409-
YIQColorspace correspond to perceptual color differences more closely than do distances in RGB space. These color spaces may give better results when
410-
color reducing an image.
406+
Specify the colorspace that quantization (color reduction and mapping) is done under or to specify the colorspace when encoding an output image. Color
407+
spaces are ways of describing colors to fit the requirements of a particular application (e.g. Television, offset printing, color monitors).&nbsp; Color
408+
reduction, by default, takes place in the RGBColorspace. Empirical evidence suggests that distances in color spaces such as YUVColorspace or YIQColorspace
409+
correspond to perceptual color differences more closely than do distances in RGB space. These color spaces may give better results when color reducing an
410+
image.
411411
</p>
412412

413413
<p>

image1.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3506,7 +3506,7 @@ <h4>See also</h4>
35063506
<p>
35073507
<a href="#convolve_channel">convolve_channel</a>. The <a href="image2.html#edge">edge</a>, <a href="image2.html#emboss">emboss</a>,
35083508
<a href="image2.html#gaussian_blur">gaussian_blur</a>, <a href="image2.html#motion_blur">motion_blur</a> and
3509-
<a href="image2.html#sharpen">sharpen</a> methods use convolution to do their work.
3509+
<a href="image3.html#sharpen">sharpen</a> methods use convolution to do their work.
35103510
</p>
35113511

35123512
<h4>Magick API</h4>
@@ -3920,7 +3920,7 @@ <h4>See also</h4>
39203920
<a href="imageattrs.html#iptc_profile">iptc_profile</a> attribute or
39213921
<a href="imageattrs.html#color_profile">color_profile</a>
39223922
attribute to nil causes the profile to be deleted. Also see
3923-
<a href="image3.html#strip_bang">strip!</a> and <a href="imageattrs.html#add_profile">add_profile</a>.
3923+
<a href="image3.html#strip_bang">strip!</a> and <a href="image1.html#add_profile">add_profile</a>.
39243924
</p>
39253925

39263926
<h4>Magick API</h4>
@@ -4243,7 +4243,7 @@ <h4>Arguments</h4>
42434243
<p>
42444244
You can specify additional arguments by setting Info attributes in a block associated with the method call. Specifically, you can set the name of a
42454245
non-default X Window screen with the
4246-
<code><a href="info.html#Info.server_name_eq">server_name</a></code>
4246+
<code><a href="info.html#server_name">server_name</a></code>
42474247
attribute.
42484248
</p>
42494249

imageattrs.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h4>See also</h4>
401401

402402
<p>
403403
<a href="image1.html#add_profile">add_profile</a>, <a href="image1.html#delete_profile">delete_profile</a>,
404-
<a href="image1.html#each_profile">each_profile</a>,
404+
<a href="image2.html#each_profile">each_profile</a>,
405405
<a href="image3.html#profile_bang">profile!</a>
406406
</p>
407407
</div>
@@ -435,8 +435,8 @@ <h4>Description</h4>
435435

436436
<p class="imquote">
437437
Image pixel interpretation. If the
438-
<a href="constants.html#ColorspaceType">colorspace</a> is RGBColorspace the pixels are red, green, blue. If <a href="#matte">matte</a> is true, then
439-
red, green, blue, and opacity. If it is CMYKColorspace, the pixels are cyan, yellow, magenta, black. Otherwise the colorspace is ignored.
438+
<a href="constants.html#ColorspaceType">colorspace</a> is RGBColorspace the pixels are red, green, blue. If <a href="image1.html#alpha_q">alpha?</a> is
439+
true, then red, green, blue, and opacity. If it is CMYKColorspace, the pixels are cyan, yellow, magenta, black. Otherwise the colorspace is ignored.
440440
</p>
441441

442442
<h4>Argument</h4>
@@ -723,11 +723,11 @@ <h4>Description</h4>
723723

724724
<h4>Argument</h4>
725725

726-
<p>A <a href="constants.html#FilterTypes">FilterTypes</a> constant.</p>
726+
<p>A <a href="constants.html#FilterType">FilterType</a> constant.</p>
727727

728728
<h4>Returns</h4>
729729

730-
<p>A <a href="constants.html#FilterTypes">FilterTypes</a> constant.</p>
730+
<p>A <a href="constants.html#FilterType">FilterType</a> constant.</p>
731731
</div>
732732

733733
<div class="sig">
@@ -946,7 +946,7 @@ <h4>See also</h4>
946946

947947
<p>
948948
<a href="image1.html#add_profile">add_profile</a>, <a href="image1.html#delete_profile">delete_profile</a>,
949-
<a href="image1.html#each_profile">each_profile</a>.
949+
<a href="image2.html#each_profile">each_profile</a>.
950950
<a href="image3.html#profile_bang">profile!</a>
951951
</p>
952952
</div>

imusage.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -267,11 +267,11 @@ <h2 id="color_names">Color names</h2>
267267
<p>The alpha channel is the opacity of the image, which can range from 0 (Magick::OpaqueOpacity) to QuantumRange (Magick::TransparentOpacity).</p>
268268

269269
<p>
270-
A <code>Pixel</code> object contains the numeric representation of a color. The <a href="struct.html#Pixel.from_color">Pixel.from_color</a> method
271-
converts a color name to a pixel. There are two methods to convert a pixel to a color name. The
272-
<a href="struct.html#Pixel.to_color">Pixel#to_color</a> method requires that you specify whether the alpha (opacity) channel is used, the depth (8 or 16)
273-
and the color standard to use. The <a href="image3.html#to_color">Image#to_color</a> method uses the image's
274-
<a href="imageattrs.html#depth">depth</a> attribute and <a href="image1.html#alpha">alpha</a> method.
270+
A <code>Pixel</code> object contains the numeric representation of a color. The <a href="struct.html#Pixel">Pixel.from_color</a> method converts a color
271+
name to a pixel. There are two methods to convert a pixel to a color name. The <a href="struct.html#Pixel">Pixel#to_color</a> method requires that you
272+
specify whether the alpha (opacity) channel is used, the depth (8 or 16) and the color standard to use. The
273+
<a href="image3.html#to_color">Image#to_color</a> method uses the image's <a href="imageattrs.html#depth">depth</a> attribute and
274+
<a href="image1.html#alpha">alpha</a> method.
275275
</p>
276276

277277
<p><em>Hint:</em> You can specify the transparent color as "none", "transparent", "#00000000", or rgba(0, 0, 0, 0.0).</p>

optequiv.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -770,7 +770,7 @@ <h3>Introduction</h3>
770770

771771
<td>
772772
This option corresponds to the
773-
<a href="constants.html#FilterTypes">filter</a> option to Image#<a href="image3.html#resize">resize</a>.
773+
<a href="constants.html#FilterType">filter</a> option to Image#<a href="image3.html#resize">resize</a>.
774774
</td>
775775
</tr>
776776

rvg.html

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,6 @@ <h4>Arguments</h4>
166166
call <a href="#units">conversion methods</a> to use units such as inches and millimeters instead of pixels.
167167
</p>
168168

169-
<p>
170-
Otherwise, <span class="arg">width</span> and <span class="arg">height</span> specify the area of the viewbox. If the RVG object will be used as an
171-
argument to the <a href="rvguse.html#use">use</a> method, then <span class="arg">width</span> and <span class="arg">height</span> may be omitted here,
172-
then specified as arguments to <code>use</code>.
173-
</p>
174-
175169
<h4>Returns</h4>
176170

177171
<p>An RVG object</p>
@@ -181,8 +175,7 @@ <h4>Example</h4>
181175
<p>
182176
See the <a href="rvgtut.html">tutorial</a> for a simple example. The image below demonstrates an advanced use of <code>RVG.new</code>. This example
183177
creates an RVG object that draws an orange-and-green target. The <span class="arg">width</span> and <span class="arg">height</span> arguments are
184-
omitted in the <code>RVG.new</code> call. Instead, the viewport width and height are specified as arguments to 4 invocations of
185-
<a href="rvguse.html#use">use</a>. Each <code>use</code> specifies a different viewport size, so the same RVG object draws 4 different-sized targets.
178+
omitted in the <code>RVG.new</code> call.
186179
</p>
187180

188181
<p>Click the image to see the example script.</p>
@@ -339,7 +332,7 @@ <h4>Argument</h4>
339332

340333
<dd>
341334
The image is scaled to fit. The image proportions are retained. Any part of the background that is not covered by the image is colored with the
342-
<a href="#RVG_background_color">background color</a>.
335+
background color.
343336
</dd>
344337
</dl>
345338

rvgpattern.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ <h4>Example</h4>
301301

302302
<p>
303303
See the example for
304-
<a href="#RVG_preserve_aspect_ratio">preserve_aspect_ratio</a> in <code>class RVG</code>.
304+
<a href="#preserve_aspect_ratio">preserve_aspect_ratio</a> in <code>class RVG</code>.
305305
</p>
306306

307307
<h4>Returns</h4>

rvgtext.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ <h4>Description</h4>
9494
<p>
9595
This method is usually invoked indirectly via the text method in the
9696
<a href="rvgclip.html#new">RVG::ClipPath</a>, <a href="rvggroup.html#new">RVG::Group</a>, <a href="rvgpattern.html#new">RVG::Pattern</a>, and
97-
<a href="rvg.html#new">RVG</a> classes.
97+
<a href="rvg.html#RVG_new">RVG</a> classes.
9898
</p>
9999

100100
<p>

rvguse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ <h4>Description</h4>
5858
<p>
5959
This method is usually invoked indirectly via the
6060
<code>use</code> method in the <a href="rvg.html#RVG_use">RVG</a>, <a href="rvgclip.html#use">RVG::ClipPath</a>,
61-
<a href="rvggroup.html#use">RVG::Group</a>, and <a href="rvgpattern.html#use">RVG::Pattern</a> classes.
61+
<a href="rvggroup.html#use">RVG::Group</a>, and <a href="rvgpattern.html#RVG_use">RVG::Pattern</a> classes.
6262
</p>
6363

6464
<p>

0 commit comments

Comments
 (0)