Skip to content

Commit

Permalink
Update documents (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
Watson1978 authored Jul 25, 2024
1 parent 7f92ca2 commit 38b6b35
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 32 deletions.
10 changes: 5 additions & 5 deletions constants.html
Original file line number Diff line number Diff line change
Expand Up @@ -403,11 +403,11 @@ <h3 class="const" id="ClassType">ClassType</h3>
<h3 class="const" id="ColorspaceType">ColorspaceType</h3>

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

<p>
Expand Down
6 changes: 3 additions & 3 deletions image1.html
Original file line number Diff line number Diff line change
Expand Up @@ -3506,7 +3506,7 @@ <h4>See also</h4>
<p>
<a href="#convolve_channel">convolve_channel</a>. The <a href="image2.html#edge">edge</a>, <a href="image2.html#emboss">emboss</a>,
<a href="image2.html#gaussian_blur">gaussian_blur</a>, <a href="image2.html#motion_blur">motion_blur</a> and
<a href="image2.html#sharpen">sharpen</a> methods use convolution to do their work.
<a href="image3.html#sharpen">sharpen</a> methods use convolution to do their work.
</p>

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

<h4>Magick API</h4>
Expand Down Expand Up @@ -4243,7 +4243,7 @@ <h4>Arguments</h4>
<p>
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
non-default X Window screen with the
<code><a href="info.html#Info.server_name_eq">server_name</a></code>
<code><a href="info.html#server_name">server_name</a></code>
attribute.
</p>

Expand Down
12 changes: 6 additions & 6 deletions imageattrs.html
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ <h4>See also</h4>

<p>
<a href="image1.html#add_profile">add_profile</a>, <a href="image1.html#delete_profile">delete_profile</a>,
<a href="image1.html#each_profile">each_profile</a>,
<a href="image2.html#each_profile">each_profile</a>,
<a href="image3.html#profile_bang">profile!</a>
</p>
</div>
Expand Down Expand Up @@ -435,8 +435,8 @@ <h4>Description</h4>

<p class="imquote">
Image pixel interpretation. If the
<a href="constants.html#ColorspaceType">colorspace</a> is RGBColorspace the pixels are red, green, blue. If <a href="#matte">matte</a> is true, then
red, green, blue, and opacity. If it is CMYKColorspace, the pixels are cyan, yellow, magenta, black. Otherwise the colorspace is ignored.
<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
true, then red, green, blue, and opacity. If it is CMYKColorspace, the pixels are cyan, yellow, magenta, black. Otherwise the colorspace is ignored.
</p>

<h4>Argument</h4>
Expand Down Expand Up @@ -723,11 +723,11 @@ <h4>Description</h4>

<h4>Argument</h4>

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

<h4>Returns</h4>

<p>A <a href="constants.html#FilterTypes">FilterTypes</a> constant.</p>
<p>A <a href="constants.html#FilterType">FilterType</a> constant.</p>
</div>

<div class="sig">
Expand Down Expand Up @@ -946,7 +946,7 @@ <h4>See also</h4>

<p>
<a href="image1.html#add_profile">add_profile</a>, <a href="image1.html#delete_profile">delete_profile</a>,
<a href="image1.html#each_profile">each_profile</a>.
<a href="image2.html#each_profile">each_profile</a>.
<a href="image3.html#profile_bang">profile!</a>
</p>
</div>
Expand Down
10 changes: 5 additions & 5 deletions imusage.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,11 +267,11 @@ <h2 id="color_names">Color names</h2>
<p>The alpha channel is the opacity of the image, which can range from 0 (Magick::OpaqueOpacity) to QuantumRange (Magick::TransparentOpacity).</p>

<p>
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
converts a color name to a pixel. There are two methods to convert a pixel to a color name. The
<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)
and the color standard to use. The <a href="image3.html#to_color">Image#to_color</a> method uses the image's
<a href="imageattrs.html#depth">depth</a> attribute and <a href="image1.html#alpha">alpha</a> method.
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
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
specify whether the alpha (opacity) channel is used, the depth (8 or 16) and the color standard to use. The
<a href="image3.html#to_color">Image#to_color</a> method uses the image's <a href="imageattrs.html#depth">depth</a> attribute and
<a href="image1.html#alpha">alpha</a> method.
</p>

<p><em>Hint:</em> You can specify the transparent color as "none", "transparent", "#00000000", or rgba(0, 0, 0, 0.0).</p>
Expand Down
2 changes: 1 addition & 1 deletion optequiv.html
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ <h3>Introduction</h3>

<td>
This option corresponds to the
<a href="constants.html#FilterTypes">filter</a> option to Image#<a href="image3.html#resize">resize</a>.
<a href="constants.html#FilterType">filter</a> option to Image#<a href="image3.html#resize">resize</a>.
</td>
</tr>

Expand Down
11 changes: 2 additions & 9 deletions rvg.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,12 +166,6 @@ <h4>Arguments</h4>
call <a href="#units">conversion methods</a> to use units such as inches and millimeters instead of pixels.
</p>

<p>
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
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,
then specified as arguments to <code>use</code>.
</p>

<h4>Returns</h4>

<p>An RVG object</p>
Expand All @@ -181,8 +175,7 @@ <h4>Example</h4>
<p>
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
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
omitted in the <code>RVG.new</code> call. Instead, the viewport width and height are specified as arguments to 4 invocations of
<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.
omitted in the <code>RVG.new</code> call.
</p>

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

<dd>
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
<a href="#RVG_background_color">background color</a>.
background color.
</dd>
</dl>

Expand Down
2 changes: 1 addition & 1 deletion rvgpattern.html
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ <h4>Example</h4>

<p>
See the example for
<a href="#RVG_preserve_aspect_ratio">preserve_aspect_ratio</a> in <code>class RVG</code>.
<a href="#preserve_aspect_ratio">preserve_aspect_ratio</a> in <code>class RVG</code>.
</p>

<h4>Returns</h4>
Expand Down
2 changes: 1 addition & 1 deletion rvgtext.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h4>Description</h4>
<p>
This method is usually invoked indirectly via the text method in the
<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
<a href="rvg.html#new">RVG</a> classes.
<a href="rvg.html#RVG_new">RVG</a> classes.
</p>

<p>
Expand Down
2 changes: 1 addition & 1 deletion rvguse.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h4>Description</h4>
<p>
This method is usually invoked indirectly via the
<code>use</code> method in the <a href="rvg.html#RVG_use">RVG</a>, <a href="rvgclip.html#use">RVG::ClipPath</a>,
<a href="rvggroup.html#use">RVG::Group</a>, and <a href="rvgpattern.html#use">RVG::Pattern</a> classes.
<a href="rvggroup.html#use">RVG::Group</a>, and <a href="rvgpattern.html#RVG_use">RVG::Pattern</a> classes.
</p>

<p>
Expand Down

0 comments on commit 38b6b35

Please sign in to comment.