Skip to content

Commit

Permalink
Update documents (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
Watson1978 authored Jul 25, 2024
1 parent f4125ca commit 7f92ca2
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion comtasks.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ <h2>

<p>
Use <a href="image2.html#import_pixels">Image#import_pixels</a> to load pixel data from a string buffer into an image. The pixel data must be in scanline
order, right-to-left and top-to-bottom. The data can be packed as 8-bit bytes, 16-bit halfwords, 32-bit fullwords, or as C floats or doubles. The
order, right-to-left and top-to-bottom. The data can be packed as 8-bit bytes, 16-bit half words, 32-bit full words, or as C floats or doubles. The
reciprocal method is <a href="image2.html#export_pixels_to_str">Image#export_pixels_to_str</a>.
</p>

Expand Down
16 changes: 8 additions & 8 deletions constants.html
Original file line number Diff line number Diff line change
Expand Up @@ -404,21 +404,21 @@ <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.
Colorspaces are ways of describing colors to fit the requirements of a particular application (e.g. Television, offset printing, color monitors).&nbsp;
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>
<span class="imquote"
>When encoding an output image, the colorspaces RGBColorspace, CMYKColorspace, and GRAYColorspace may be specified. The CMYKColorspace option is only
>When encoding an output image, the color spaces RGBColorspace, CMYKColorspace, and GRAYColorspace may be specified. The CMYKColorspace option is only
applicable when writing TIFF, JPEG, and Adobe Photoshop bitmap (PSD) files.</span
>
See <a href="imageattrs.html#colorspace">colorspace</a>.
</p>

<p>Each version of ImageMagick defines a subset of the colorspaces listed below. To list the subset supported by your version, issue the command:</p>
<p>Each version of ImageMagick defines a subset of the color spaces listed below. To list the subset supported by your version, issue the command:</p>
<pre class="example language-ruby">ruby -r rmagick -e"Magick::ColorspaceType.values {|cs| puts cs}"</pre>

<dl>
Expand Down Expand Up @@ -489,7 +489,7 @@ <h3 class="const" id="ColorspaceType">ColorspaceType</h3>
<dd class="imquote">Y-signal, U-signal, and V-signal colorspace. YUV is most widely used to encode color for use in television transmission.</dd>
</dl>

<p>The colorspaces in this group are typically associated with the DPX and Cineon image formats used in the motion picture industry.</p>
<p>The color spaces in this group are typically associated with the DPX and Cineon image formats used in the motion picture industry.</p>

<dl>
<dt>Rec601LumaColorspace</dt>
Expand Down Expand Up @@ -762,7 +762,7 @@ <h3 class="const" id="CompositeOperator">CompositeOperator</h3>
<dt>LinearDodgeCompositeOp</dt>

<dd class="imquote">
This is equivelent to <code>PlusCompositeOp</code> in that the color channels are simply added, however it does not "plus" the alpha channel, but uses
This is equivalent to <code>PlusCompositeOp</code> in that the color channels are simply added, however it does not "plus" the alpha channel, but uses
the normal <code>OverCompositeOp</code> alpha blending, which transparencies are involved. Produces a sort of additive multiply-like result.
</dd>

Expand Down Expand Up @@ -831,7 +831,7 @@ <h3 class="const" id="CompositeOperator">CompositeOperator</h3>
<dt>PinLightCompositeOp</dt>

<dd class="imquote">
Similar to <code>HardLightCompositeOp</code>, but using sharp linear shadings, to similate the effects of a strong 'pinhole' light source.
Similar to <code>HardLightCompositeOp</code>, but using sharp linear shadings, to simulate the effects of a strong 'pinhole' light source.
</dd>

<dt>PlusCompositeOp</dt>
Expand Down Expand Up @@ -885,7 +885,7 @@ <h3 class="const" id="CompositeOperator">CompositeOperator</h3>

<dd class="imquote">
The result of <code>composite image</code> - <code>image</code>, with underflow wrapping around (mod 256). The add and subtract operators can be used to
perform reversable transformations.
perform reversible transformations.
</dd>

<dt>ThresholdCompositeOp</dt>
Expand All @@ -894,7 +894,7 @@ <h3 class="const" id="CompositeOperator">CompositeOperator</h3>

<dt>VividLightCompositeOp</dt>

<dd class="imquote">A modified <code>LinearLightCompositeOp</code> designed to preserve very stong primary and secondary colors in the image.</dd>
<dd class="imquote">A modified <code>LinearLightCompositeOp</code> designed to preserve very strong primary and secondary colors in the image.</dd>

<dt>XorCompositeOp</dt>

Expand Down
8 changes: 4 additions & 4 deletions draw.html
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ <h4>Description</h4>
<p class="imquote">
The TypeMetric class provides the means to pass data from the Draw class's get_type_metric method to the user. It provides information regarding font
metrics such as ascent, descent, text width, text height, and maximum horizontal advance. The units of these font metrics are in pixels...(T)he
metrics are dependent on the current Image font (default Ghostscript's "Helvetica"), pointsize (default 12 points), and x/y resolution (default 72
metrics are dependent on the current Image font (default Ghostscript's "Helvetica"), point size (default 12 points), and x/y resolution (default 72
DPI) settings.
</p>

Expand All @@ -696,8 +696,8 @@ <h4>Description</h4>
<p class="imquote">where resolution is in dots-per-inch (DPI). This means that at the default image resolution, there is one pixel per point.</p>

<p class="imquote">
Note that a font's pointsize is only a first-order approximation of the font height (ascender + descender) in points. The relationship between the
specified pointsize and the rendered font height is determined by the font designer.
Note that a font's point size is only a first-order approximation of the font height (ascender + descender) in points. The relationship between the
specified point size and the rendered font height is determined by the font designer.
</p>

<p class="imquote">
Expand All @@ -713,7 +713,7 @@ <h4>Arguments</h4>
<dt>image <em>(optional)</em></dt>

<dd>
The image on which the string will be rendered. ImageMagick uses the attributes of the image (font name, pointsize, etc.) to compute the metrics. If
The image on which the string will be rendered. ImageMagick uses the attributes of the image (font name, point size, etc.) to compute the metrics. If
this argument is omitted,
<code>get_type_metrics</code> substitutes a dummy image with default attributes. The <span class="arg">string</span> argument may not contain any of
the special characters shown in <a href="#spec_chars_table">this</a> table.
Expand Down
8 changes: 4 additions & 4 deletions info.html
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ <h4 id="user_option">The "user" option</h4>
>

<p>
These methods propogate the value of the "user" option to new image(s):
These methods propagate the value of the "user" option to new image(s):
<code
>Image.new, ImageList.new, ImageList.new_image, Image.capture, Image.from_blob, ImageList.from_blob, Image.read, ImageList.read, Image.read_inline,
and Image.ping</code
Expand Down Expand Up @@ -833,7 +833,7 @@ <h3 id="endian">endian</h3>
<div class="desc">
<h4>Description</h4>

<p>Specify the endianess of the image when reading the image file.</p>
<p>Specify the endian of the image when reading the image file.</p>

<h4>Argument</h4>

Expand Down Expand Up @@ -1317,12 +1317,12 @@ <h4>Description</h4>

<p class="imquote">
The transparent color. Sometimes used for saving to image formats such as GIF and PNG8 which uses this color to represent boolean transparency. This
does not make a color transparent, just defines what color the transparent color will be in the color pallette of the saved image.
does not make a color transparent, just defines what color the transparent color will be in the color palette of the saved image.
</p>

<p class="imquote">
This attribute allows you to have both a opaque visible color as well as a transparent color of the same color value without conflict. That is you can
use the same color for both the transparent and opaque color areas within an image. This in turn frees to you to select a transparenct color that is
use the same color for both the transparent and opaque color areas within an image. This in turn frees to you to select a transparent color that is
appropriate when a image is displayed by application that does not handle a transparent color index, while allowing RMagick to correctly handle images
of this type.
</p>
Expand Down
2 changes: 1 addition & 1 deletion magick.html
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ <h4>Returns</h4>

<h4>Notes</h4>

<p>This method supercedes <code>set_cache_threshold</code>.</p>
<p>This method supersedes <code>set_cache_threshold</code>.</p>

<p>
Setting the <code>:time</code> limit resets the elapsed time to zero in the pixel cache. Call it before any operation that you need to set a time limit
Expand Down

0 comments on commit 7f92ca2

Please sign in to comment.