Skip to content

Commit f4125ca

Browse files
authored
Update documents (#33)
1 parent 1fe1c62 commit f4125ca

File tree

11 files changed

+82
-121
lines changed

11 files changed

+82
-121
lines changed

comtasks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ <h2>
205205
<p>
206206
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
207207
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
208-
reciprocal method is <a href="image3.html#export_pixels_to_str">Image#export_pixels_to_str</a>.
208+
reciprocal method is <a href="image2.html#export_pixels_to_str">Image#export_pixels_to_str</a>.
209209
</p>
210210

211211
<h2 id="gray">Converting a color image to grayscale</h2>

constants.html

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ <h3 class="const" style="margin-top: 0" id="Miscellaneous_constants">Miscellaneo
250250

251251
<h3 class="const" id="AlignType">AlignType</h3>
252252

253-
<p>Specify text alignment. See <a href="draw.html#Draw.align_eq">align=</a>, <a href="draw.html#Draw.text_align">text_align</a>.</p>
253+
<p>Specify text alignment. See <a href="draw.html#align_eq">align=</a>, <a href="draw.html#text_align">text_align</a>.</p>
254254

255255
<dl>
256256
<dt>UndefinedAlign</dt>
@@ -324,7 +324,7 @@ <h3 class="const" id="ChannelType">ChannelType</h3>
324324
Specify an image channel. A channel is a color component of a pixel. In the RGB colorspace the channels are red, green, and blue. There may also be an
325325
alpha (transparency/opacity) channel. In the CMYK colorspace the channels area cyan, magenta, yellow, and black. In the HSL colorspace the channels are
326326
hue, saturation, and lightness. In the Gray colorspace the only channel is gray. See
327-
<a href="image1.html#channel">Image#channel</a> and <a href="info.html#channel">Image::Info#channel=</a>.
327+
<a href="image1.html#channel">Image#channel</a> and <a href="info.html#channel">Image::Info#channel</a>.
328328
</p>
329329

330330
<dl>
@@ -633,8 +633,8 @@ <h3 class="const" id="CompositeOperator">CompositeOperator</h3>
633633

634634
<dd>
635635
If the composite image's
636-
<a href="imageattrs.html#matte">matte</a> attribute is <code>true</code>, copy the opacity channel from the composite image to the target image.
637-
Otherwise, set the target image pixel's opacity to the intensity of the corresponding pixel in the composite image.
636+
<a href="image1.html#alpha_q">alpha?</a> is <code>true</code>, copy the opacity channel from the composite image to the target image. Otherwise, set the
637+
target image pixel's opacity to the intensity of the corresponding pixel in the composite image.
638638
</dd>
639639

640640
<dt>CopyCompositeOp</dt>
@@ -1007,7 +1007,7 @@ <h3 class="const" id="CompressionType">CompressionType</h3>
10071007
<h3 class="const" id="DecorationType">DecorationType</h3>
10081008

10091009
<p>
1010-
Use with the <a href="draw.html#decorate">decorate=</a> method in the Draw class to specify the text decoration for the
1010+
Use with the <a href="draw.html#decorate">decorate</a> method in the Draw class to specify the text decoration for the
10111011
<a href="draw.html#annotate">annotate</a> method.
10121012
</p>
10131013

@@ -1102,7 +1102,7 @@ <h3 class="const" id="DistortMethod">DistortMethod</h3>
11021102
<h3 class="const" id="DitherMethod">DitherMethod</h3>
11031103

11041104
<p>
1105-
Specify the method of dithering for <a href="image1.html#remap">remap</a>, <a href="image3.html#quantize">quantize</a>,
1105+
Specify the method of dithering for <a href="image3.html#remap">remap</a>, <a href="image3.html#quantize">quantize</a>,
11061106
<a href="image3.html#posterize">posterize</a>, etc.
11071107
</p>
11081108

@@ -1326,7 +1326,7 @@ <h3 class="const" id="ImageType">ImageType</h3>
13261326
<p>
13271327
Indicate
13281328
<span class="imquote">the type classification of the image.</span> See <a href="imageattrs.html#image_type">image_type</a> and
1329-
<a href="info.html#image_type_eq">image_type=</a>.
1329+
<a href="info.html#image_type">image_type=</a>.
13301330
</p>
13311331

13321332
<dl>
@@ -1518,10 +1518,7 @@ <h3 class="const" id="MagickFunction">MagickFunction</h3>
15181518
<dt>ArctanFunction</dt>
15191519
</dl>
15201520

1521-
<p>
1522-
For FilterInterpolatePixel, specify the filter with the
1523-
<a href="imageattrs.html#filter">filter</a> attribute. Specify the sharpness with the <a href="imageattrs.html#blur">blur</a> attribute.
1524-
</p>
1521+
<p>For FilterInterpolatePixel, specify the filter with the <a href="imageattrs.html#filter">filter</a> attribute.</p>
15251522

15261523
<h3 class="const" id="MetricType">MetricType</h3>
15271524

draw.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1362,7 +1362,7 @@ <h4>Description</h4>
13621362
<p>
13631363
Define a clip-path. Within <span class="arg">block</span>, call other drawing primitive methods (<code>rectangle</code>, <code>polygon</code>,
13641364
<code>text</code>, etc.) to define the clip-path. The union of all the primitives (excluding the effects of rendering methods such as
1365-
<code>stroke_width</code>, etc.) is the clip-path. After the clip-path is invoked by the <a href="#clip_path">clip-path</a> method, anything drawn on
1365+
<code>stroke_width</code>, etc.) is the clip-path. After the clip-path is invoked by the <a href="#clip_path">clip_path</a> method, anything drawn on
13661366
the image inside the clip-path will appear. Anything drawn outside the clip-path will be hidden. (See <a href="#clip_rule">clip_rule</a> for a
13671367
definition of how ImageMagick decides what is "inside" and what is "outside" of the clip-path.)
13681368
</p>
@@ -1869,7 +1869,7 @@ <h4>Returns</h4>
18691869
<p>self</p>
18701870

18711871
<h4>See also</h4>
1872-
<a href="#color">color</a><a href="image2.html#matte_point">matte_point</a>, <a href="image2.html#matte_replace">matte_replace</a>,
1872+
<a href="#color">color</a>, <a href="image2.html#matte_point">matte_point</a>, <a href="image2.html#matte_replace">matte_replace</a>,
18731873
<a href="image2.html#matte_floodfill">matte_floodfill</a>, <a href="image2.html#matte_fill_to_border">matte_fill_to_border</a>,
18741874
<a href="image2.html#opaque">opaque</a>,
18751875
<a href="image3.html#transparent">transparent</a>

ilist.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,7 @@ <h4>Montage attributes</h4>
11271127

11281128
<dt>gravity=</dt>
11291129

1130-
<dd>The <a href="constants.html#GravityType">direction</a> used when adding the tile labels. (See <a href="draw.html#Draw.annotate">annotate</a>.)</dd>
1130+
<dd>The <a href="constants.html#GravityType">direction</a> used when adding the tile labels. (See <a href="draw.html#annotate">Draw#annotate</a>.)</dd>
11311131

11321132
<dt>matte_color=</dt>
11331133

@@ -1270,7 +1270,7 @@ <h4>Example</h4>
12701270

12711271
<h4>See also</h4>
12721272
<a href="#coalesce">coalesce</a>, <a href="#flatten_images">flatten_images</a>, <a href="#montage">montage</a>,
1273-
<a href="#optimize_images">optimize_images</a>
1273+
<a href="#optimize_layers">optimize_layers</a>
12741274

12751275
<h4>Magick API</h4>
12761276

@@ -1304,8 +1304,8 @@ <h4>Arguments</h4>
13041304

13051305
<p>
13061306
You can set any <a href="info.html">Image::Info</a> attributes in an associated block. These attributes supply options to be used when creating the
1307-
image. For example, you can specify the <a href="imageattrs.html#background_color">background color</a> to fill the image with (see the example), the
1308-
<a href="imageattrs.html#depth">depth</a>, <a href="imageattrs.html#border_color">border color</a>, etc.
1307+
image. For example, you can specify the <a href="imageattrs.html#background_color">background_color</a> to fill the image with (see the example), the
1308+
<a href="imageattrs.html#depth">depth</a>, <a href="imageattrs.html#border_color">border_color</a>, etc.
13091309
</p>
13101310

13111311
<h4>Returns</h4>

image1.html

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ <h4>Arguments</h4>
338338
<dd>
339339
You can specify any of these Image::Info attributes in the
340340
<em>optional arguments</em> block: <a href="info.html#colorspace">colorspace</a>, <a href="info.html#depth">depth</a>,
341-
<a href="info.html#dither">dither</a>, <a href="info.html#interlace">interlace</a>, and <a href="info.html#type">type</a>.
341+
<a href="info.html#dither">dither</a>, <a href="info.html#interlace">interlace</a>, and <a href="info.html#image_type">image_type</a>.
342342
</dd>
343343
</dl>
344344

@@ -457,10 +457,7 @@ <h4>Example</h4>
457457

458458
<h4>See also</h4>
459459

460-
<p>
461-
<a href="image2.html#import_pixels"><code>import_pixels</code></a
462-
>, <a href="image3.html#store_pixels"><code>store_pixels</code></a>
463-
</p>
460+
<p><a href="image2.html#import_pixels">import_pixels</a>, <a href="image3.html#store_pixels">store_pixels</a></p>
464461

465462
<h4>Magick API</h4>
466463

@@ -492,10 +489,7 @@ <h4>Returns</h4>
492489

493490
<h4>Example</h4>
494491

495-
<p>
496-
See <a href="image3.html#to_blob"><code>to_blob</code></a
497-
>.
498-
</p>
492+
<p>See <a href="image3.html#to_blob">to_blob</a>.</p>
499493

500494
<h4>Magick API</h4>
501495

@@ -530,9 +524,7 @@ <h4>Arguments</h4>
530524

531525
<dt>fill</dt>
532526

533-
<dd>
534-
A <a href="struct.html#fill"><code>Fill</code></a> object
535-
</dd>
527+
<dd>A <a href="struct.html#fill">Fill</a> object</dd>
536528
</dl>
537529

538530
<h4>Returns</h4>
@@ -551,7 +543,7 @@ <h4>Example</h4>
551543
<h4>See also</h4>
552544

553545
<p>
554-
<a href="ilist.html#new_image"><code>ImageList.new_image</code></a>
546+
<a href="ilist.html#new_image">ImageList.new_image</a>
555547
</p>
556548

557549
<h4>Magick API</h4>
@@ -573,7 +565,7 @@ <h4>Description</h4>
573565

574566
<p>
575567
Creates one or more images from the image file, omitting the pixel data. Only the attributes are stored in the images. This method is faster than
576-
<code><a href="#read">read</a></code> and uses less memory.
568+
<a href="#read">read</a> and uses less memory.
577569
</p>
578570

579571
<h4>Arguments</h4>
@@ -598,7 +590,7 @@ <h4>Example</h4>
598590
<h4>See also</h4>
599591

600592
<p>
601-
<a href="#read"><code>read</code></a>
593+
<a href="#read">read</a>
602594
</p>
603595

604596
<h4>Magick API</h4>
@@ -651,7 +643,7 @@ <h4>Example</h4>
651643
<h4>See also</h4>
652644

653645
<p>
654-
<a href="#ping"><code>ping</code></a>
646+
<a href="#ping">ping</a>
655647
</p>
656648

657649
<h4>Note</h4>
@@ -702,7 +694,7 @@ <h4>Example</h4>
702694
<h4>See also</h4>
703695

704696
<p>
705-
<a href="#read"><code>read</code></a>
697+
<a href="#read">read</a>
706698
</p>
707699
</div>
708700

@@ -740,10 +732,7 @@ <h4>Example</h4>
740732

741733
<h4>See also</h4>
742734

743-
<p>
744-
<a href="#aset"><code>[ ]=</code></a
745-
>, <a href="image3.html#properties"><code>properties</code></a>
746-
</p>
735+
<p><a href="#aset">[ ]=</a>, <a href="image3.html#properties">properties</a></p>
747736

748737
<h4>Magick API</h4>
749738

@@ -779,10 +768,7 @@ <h4>Example</h4>
779768

780769
<h4>See also</h4>
781770

782-
<p>
783-
<a href="#aref">[<code>&nbsp;]</code></a
784-
>, <a href="image3.html#properties"><code>properties</code></a>
785-
</p>
771+
<p><a href="#aref">[ ]</a>, <a href="image3.html#properties">properties</a></p>
786772

787773
<h4>Magick API</h4>
788774

@@ -3360,7 +3346,7 @@ <h4>Magick API</h4>
33603346
</div>
33613347

33623348
<div class="sig">
3363-
<h3 id="compress_colormap">compress_colormap</h3>
3349+
<h3 id="compress_colormap_bang">compress_colormap!</h3>
33643350

33653351
<p><span class="arg">img</span>.compress_colormap! -&gt; <em>self</em></p>
33663352
</div>

image2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -543,7 +543,7 @@ <h4>Description</h4>
543543

544544
<p>
545545
Sets the entire image to the
546-
<a href="imageattrs.html#background_color">background color</a>.
546+
<a href="imageattrs.html#background_color">background_color</a>.
547547
</p>
548548

549549
<h4>Returns</h4>
@@ -2954,7 +2954,7 @@ <h4>Returns</h4>
29542954

29552955
<h4>See also</h4>
29562956

2957-
<p><a href="imageattrs.html#opacity">opacity=</a></p>
2957+
<p><a href="image1.html#alpha">alpha</a></p>
29582958

29592959
<h4>Magick API</h4>
29602960
SetImageOpacity

image3.html

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -874,7 +874,7 @@ <h4>See also</h4>
874874
<p><a href="image2.html#function_channel">function_channel</a></p>
875875

876876
<p>
877-
The <a href="struct.html#view">Image:View</a> class supports operations on individual pixels and collections of pixels, as well as operations on
877+
The <a href="struct.html#view">Image::View</a> class supports operations on individual pixels and collections of pixels, as well as operations on
878878
channels within pixels. See <a href="#view">view</a>, below.
879879
</p>
880880

@@ -1282,7 +1282,7 @@ <h3 id="resize">resize</h3>
12821282

12831283
<p>
12841284
<span class="arg">img</span>.resize(<span class="arg">new_width</span>, <span class="arg">new_height</span>, <em>filter</em>=<a
1285-
href="constants.html#FilterTypes"
1285+
href="constants.html#FilterType"
12861286
>LanczosFilter</a
12871287
>, <em>support</em>=1.0) -&gt; <em>image</em><br />
12881288
<span class="arg">img</span>.resize(<span class="arg">scale_factor</span>) -&gt; <em>image</em>
@@ -1313,7 +1313,7 @@ <h4>Arguments</h4>
13131313
<dt>filter</dt>
13141314

13151315
<dd>
1316-
The <a href="constants.html#FilterTypes">filter</a> to use when resizing. If you do not specify a filter argument, resize uses the value of the
1316+
The <a href="constants.html#FilterType">filter</a> to use when resizing. If you do not specify a filter argument, resize uses the value of the
13171317
receiver's <a href="imageattrs.html#filter">filter attribute</a>.
13181318
<span class="imquote"
13191319
>Most of the filters are FIR (finite impulse response), however, Bessel, Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc are
@@ -1323,10 +1323,7 @@ <h4>Arguments</h4>
13231323

13241324
<dt>support</dt>
13251325

1326-
<dd>
1327-
Values &gt; 1 increase the blurriness. Values &lt; 1 increase the sharpness. If this argument is not specified, <code>resize</code> uses the value of
1328-
the receiver's <a href="imageattrs.html#blur">blur</a> attribute.
1329-
</dd>
1326+
<dd>Values &gt; 1 increase the blurriness. Values &lt; 1 increase the sharpness.</dd>
13301327

13311328
<dt>scale_factor</dt>
13321329

@@ -1356,7 +1353,7 @@ <h4>Magick API</h4>
13561353
<h3 id="resize_bang">resize!</h3>
13571354

13581355
<p>
1359-
<span class="arg">img</span>.resize!(<em>new_width</em>, <em>new_height</em>, <em>filter</em>=<a href="constants.html#FilterTypes">LanczosFilter</a>,
1356+
<span class="arg">img</span>.resize!(<em>new_width</em>, <em>new_height</em>, <em>filter</em>=<a href="constants.html#FilterType">LanczosFilter</a>,
13601357
<em>support</em>=1.0) -&gt; <em>self</em><br />
13611358
<span class="arg">img</span>.resize!(<span class="arg">scale_factor</span>) -&gt; <em>self</em>
13621359
</p>
@@ -1632,7 +1629,7 @@ <h4>Description</h4>
16321629
<p>
16331630
Rotate the receiver by the specified angle. Positive angles rotate clockwise while negative angles rotate counter-clockwise. New pixels introduced by
16341631
the rotation are the same color as the current
1635-
<a href="imageattrs.html#background_color">background color</a>. Set the background color to "none" to make the new pixels transparent black.
1632+
<a href="imageattrs.html#background_color">background_color</a>. Set the background color to "none" to make the new pixels transparent black.
16361633
</p>
16371634

16381635
<h4>Arguments</h4>
@@ -2080,7 +2077,7 @@ <h4>Arguments</h4>
20802077

20812078
<dd>
20822079
The desired depth (must be no greater than
2083-
<a href="constants.html">QuantumDepth</a>)
2080+
<a href="constants.html#Miscellaneous_constants">QuantumDepth</a>)
20842081
</dd>
20852082
</dl>
20862083

@@ -3368,8 +3365,7 @@ <h4>Description</h4>
33683365

33693366
<p>
33703367
Returns the color name for a pixel. Unlike the
3371-
<code>Pixel#to_color</code> method, to_color uses the <a href="imageattrs.html#depth">depth</a> and <a href="imageattrs.html#matte">matte</a> attributes
3372-
of the image to determine the color name.
3368+
<code>Pixel#to_color</code> method, to_color uses the <a href="imageattrs.html#depth">depth</a> attribute of the image to determine the color name.
33733369
</p>
33743370

33753371
<h4>Arguments</h4>
@@ -4330,7 +4326,7 @@ <h4>Description</h4>
43304326

43314327
<p>
43324328
If the argument is an open file, ImageMagick will write the image in its current format. You can force a different format by setting the image's
4333-
<a href="imageattrs.html#Image.format">format</a> attribute.
4329+
<a href="imageattrs.html#format">format</a> attribute.
43344330
</p>
43354331

43364332
<h4>Arguments</h4>

imusage.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,8 @@ <h2 id="color_names">Color names</h2>
270270
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
271271
converts a color name to a pixel. There are two methods to convert a pixel to a color name. The
272272
<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 depth and
274-
<a href="imageattrs.html#matte">matte</a> attributes. If <code>matte</code> is false the opacity value is ignored.
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.
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>
@@ -361,7 +361,7 @@ <h2 id="classtype">DirectClass and PseudoClass</h2>
361361

362362
<p>
363363
GIF format images are PseudoClass. JPEG format images are DirectClass. You can change the class of a image with the
364-
<code><a href="imageattrs.html#class_type_eq">class_type=</a></code>
364+
<code><a href="imageattrs.html#class_type">class_type</a></code>
365365
method.
366366
</p>
367367

0 commit comments

Comments
 (0)