doc/info.html in rmagick-2.0.0 vs doc/info.html in rmagick-2.1.0
- old
+ new
@@ -4,11 +4,11 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
- <title>RMagick 2.0.0: class Image::Info - Optional method
+ <title>RMagick 2.1.0: class Image::Info - Optional method
arguments</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
@@ -42,11 +42,11 @@
/*]]>*/
</style>
</head>
<body>
- <h6 id="header">RMagick 2.0.0 User's Guide and Reference</h6>
+ <h6 id="header">RMagick 2.1.0 User's Guide and Reference</h6>
<div class="nav">
« <a href="struct.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"constants.html">Next</a> »
@@ -83,10 +83,12 @@
<li><a href="#background_color">background_color</a></li>
<li><a href="#border_color">border_color</a></li>
+ <li><a href="#caption">caption</a></li>
+
<li><a href="#colorspace">colorspace</a></li>
<li><a href="#comment">comment</a></li>
<li><a href="#compression">compression</a></li>
@@ -98,17 +100,17 @@
<li><a href="#depth">depth</a></li>
<li><a href="#dispose">dispose</a></li>
<li><a href="#dither">dither</a></li>
-
- <li><a href="#extract">extract</a></li>
</ul>
</div>
<div class="toccol">
<ul>
+ <li><a href="#extract">extract</a></li>
+
<li><a href="#filename">filename</a></li>
<li><a href="#fill">fill</a></li>
<li><a href="#font">font</a></li>
@@ -130,17 +132,17 @@
<li><a href="#monitor">monitor</a></li>
<li><a href="#monochrome">monochrome</a></li>
<li><a href="#orientation">orientation</a></li>
-
- <li><a href="#origin">origin</a></li>
</ul>
</div>
<div class="toccol">
<ul>
+ <li><a href="#origin">origin</a></li>
+
<li><a href="#page">page</a></li>
<li><a href="#pointsize">pointsize</a></li>
<li><a href="#quality">quality</a></li>
@@ -434,11 +436,11 @@
<div class="sig">
<h3 id="attenuate">attenuate</h3>
<p><span class="arg">self</span>.attenuate= <span class=
- "arg">aNumeric</span></p>
+ "arg">number</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -448,11 +450,11 @@
<div class="sig">
<h3 id="authenticate">authenticate</h3>
<p><span class="arg">self.</span>authenticate= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -465,47 +467,74 @@
<div class="sig">
<h3 id="background_color">background_color</h3>
<p><span class="arg">self.</span>background_color= <span class=
- "arg">aString</span> or <span class="arg">aPixel</span></p>
+ "arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image background color. The default is "white".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
- <a href="struct.html#Pixel">aPixel</a>.</p>
+ <a href="struct.html#Pixel">Pixel</a>.</p>
</div>
<div class="sig">
<h3 id="border_color">border_color</h3>
<p><span class="arg">self.</span>border_color= <span class=
- "arg">aString</span> or <span class="arg">aPixel</span></p>
+ "arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image border color. The default is "#dfdfdf".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
- <a href="struct.html#Pixel">aPixel</a>.</p>
+ <a href="struct.html#Pixel">Pixel</a>.</p>
</div>
<div class="sig">
+ <h3 id="caption">caption</h3>
+
+ <p><span class="arg">self.</span>caption= <span class=
+ "arg">string</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>When used with <a href="image1.html#read">Image.read</a>,
+ assigns a caption to an image. The caption is an image
+ property:</p>
+ <pre>
+img = Magick::Image.read("xc:white") do
+ self.caption = "a new caption"
+ self.size = "20x20"
+end
+p img.first.properties » {"caption"=>"a new caption"}
+p img.first['caption'] » "a new caption"
+</pre>
+
+ <h4>Arguments</h4>
+
+ <p>A string.</p>
+ </div>
+
+ <div class="sig">
<h3 id="colorspace">colorspace</h3>
<p><span class="arg">self.</span>colorspace= <span class=
- "arg">aColorspaceType</span></p>
+ "arg">colorspace</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -517,11 +546,11 @@
<div class="sig">
<h3 id="comment">comment</h3>
<p><span class="arg">self.</span>comment= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -539,21 +568,21 @@
<div class="sig">
<h3 id="compression">compression</h3>
<p><span class="arg">self.</span>compression= <span class=
- "arg">aCompressionType</span></p>
+ "arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specifies the type of compression used when writing the image.
- Only some image formats support compression. For those that do,
- only some compression types are supported. If you specify an
- compression type that is not supported, the default compression
- type (usually NoCompression) is used instead.</p>
+ <p>Specifies the type of compression used when writing the
+ image. Only some image formats support compression. For those
+ that do, only some compression types are supported. If you
+ specify an compression type that is not supported, the default
+ compression type (usually NoCompression) is used instead.</p>
<p>Some compression types support varying levels of
compression. See the <a href=
"#quality"><code>quality</code></a> attribute.</p>
@@ -710,11 +739,11 @@
<div class="sig">
<h3 id="density">density</h3>
<p><span class="arg">self.</span>density= <span class=
- "arg">aString</span> or <span class="arg">aGeometry</span></p>
+ "arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -737,11 +766,11 @@
<div class="sig">
<h3 id="delay">delay</h3>
<p><span class="arg">self.</span>delay= <span class=
- "arg">anInteger</span></p>
+ "arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -754,11 +783,11 @@
<div class="sig">
<h3 id="depth">depth</h3>
<p><span class="arg">self.</span>depth= <span class=
- "arg">aNumber</span></p>
+ "arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -777,11 +806,11 @@
<div class="sig">
<h3 id="dispose">dispose</h3>
<p><span class="arg">self.</span>dispose= <span class=
- "arg">aDisposeType</span></p>
+ "arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -817,19 +846,20 @@
<div class="sig">
<h3 id="extract">extract</h3>
<p><span class="arg"><em>self.</em></span>extract= <span class=
- "arg">aString</span> or <span class="arg">aGeometry</span></p>
+ "arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specifies a portion of an image to be extracted when the image
- is constituted. This attribute can be used to identify a subset
- of an image that is otherwise too large to keep in memory.</p>
+ <p>Specifies a portion of an image to be extracted when the
+ image is constituted. This attribute can be used to identify a
+ subset of an image that is otherwise too large to keep in
+ memory.</p>
<h4>Arguments</h4>
<p>Either a geometry string or a <a href=
"struct.html#Geometry">Geometry</a> object. For example:
@@ -838,11 +868,11 @@
<div class="sig">
<h3 id="filename">filename</h3>
<p><span class="arg">self.</span>filename= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -851,11 +881,11 @@
<div class="sig">
<h3 id="fill">fill</h3>
<p><span class="arg">self.</span>fill= <span class=
- "arg">aString</span> or <span class="arg">aPixel</span></p>
+ "arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -863,18 +893,18 @@
the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
- <a href="struct.html#Pixel">aPixel</a>.</p>
+ <a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="font">font</h3>
<p><span class="arg">self.</span>font= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -883,11 +913,11 @@
<div class="sig">
<h3 id="format">format</h3>
<p><span class="arg">self.</span>format= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -902,11 +932,11 @@
<div class="sig">
<h3 id="fuzz">fuzz</h3>
<p><span class="arg">self.</span>fuzz= <span class=
- "arg">aNumeric</span> or <span class="arg">aString</span></p>
+ "arg">number</span> or <span class="arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -928,11 +958,11 @@
<div class="sig">
<h3 id="gravity">gravity</h3>
<p><span class="arg">self.</span>gravity= <span class=
- "arg">aGravityType</span></p>
+ "arg">gravity</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -956,11 +986,11 @@
<div class="sig">
<h3 id="image_type">image_type</h3>
<p><span class="arg">self.</span>image_type= <span class=
- "arg">anImageType</span></p>
+ "arg">image_type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -976,11 +1006,11 @@
<div class="sig">
<h3 id="interlace">interlace</h3>
<p><span class="arg">self.</span>interlace= <span class=
- "arg">anInterlaceType</span></p>
+ "arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1002,11 +1032,11 @@
<div class="sig">
<h3 id="label">label</h3>
<p><span class="arg">self.</span>label= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1021,11 +1051,11 @@
<div class="sig">
<h3 id="matte_color">matte_color</h3>
<p><span class="arg">self.</span>matte_color= <span class=
- "arg">aString</span> or <span class="arg">aPixel</span></p>
+ "arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1033,18 +1063,18 @@
"#bdbdbd".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
- <a href="struct.html#Pixel">aPixel</a>.</p>
+ <a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="monitor">monitor</h3>
<p><span class="arg">self.</span>monitor= <span class=
- "arg">aProc</span></p>
+ "arg">proc</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1082,11 +1112,11 @@
<div class="sig">
<h3 id="orientation">orientation</h3>
<p><span class="arg">self</span>.orientation=<span class=
- "arg">anOrientationType</span></p>
+ "arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1100,11 +1130,11 @@
<div class="sig">
<h3 id="origin">origin</h3>
<p><span class="arg">self</span>.origin=<span class=
- "arg">aString</span> or <span class="arg">aGeometry</span></p>
+ "arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1120,11 +1150,11 @@
<div class="sig">
<h3 id="page">page</h3>
<p><span class="arg">self.</span>page= <span class=
- "arg">aString</span> or <span class="arg">aGeometry</span></p>
+ "arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1139,11 +1169,11 @@
<div class="sig">
<h3 id="pointsize">pointsize</h3>
<p><span class="arg">self.</span>pointsize= <span class=
- "arg">aNumeric</span></p>
+ "arg">number</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1153,11 +1183,11 @@
<div class="sig">
<h3 id="quality">quality</h3>
<p><span class="arg">self.</span>quality= <span class=
- "arg">anInteger</span></p>
+ "arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1170,11 +1200,11 @@
<div class="sig">
<h3 id="sampling_factor">sampling_factor</h3>
<p><span class="arg">self.</span>sampling_factor= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1196,11 +1226,11 @@
<div class="sig">
<h3 id="server_name">server_name</h3>
<p><span class="arg">self.</span>server_name= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1208,13 +1238,12 @@
</div>
<div class="sig">
<h3 id="size">size</h3>
- <p><span class="arg"><em>self.</em>size=
- <em>aString</em></span> or <span class=
- "arg">aGeometry</span></p>
+ <p><span class="arg"><em>self.</em>size= <em>string</em></span>
+ or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1238,11 +1267,11 @@
<div class="sig">
<h3 id="stroke">stroke</h3>
<p><span class="arg">self.</span>stroke= <span class=
- "arg">aString</span> or <span class="arg">aPixel</span></p>
+ "arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1250,18 +1279,18 @@
with the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
- <a href="struct.html#Pixel">aPixel</a>.</p>
+ <a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="stroke_width">stroke_width</h3>
<p><span class="arg">self.</span>stroke_width=
- <em>aNumeric</em></p>
+ <em>number</em></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1294,18 +1323,18 @@
<div class="sig">
<h3 id="tile_offset">tile_offset</h3>
<p><span class="arg">self</span>.tile_offset= <span class=
- "arg">aString</span> or <span class="arg">aGeometry</span></p>
+ "arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
- <p class="imquote">Specifies the offset for tile images, relative
- to the background image it will be tiled on.</p>
+ <p class="imquote">Specifies the offset for tile images,
+ relative to the background image it will be tiled on.</p>
<p>This attribute is useful with the "tile:" and "pattern:"
image formats.</p>
<h4>Arguments</h4>
@@ -1316,11 +1345,11 @@
<div class="sig">
<h3 id="undercolor">undercolor</h3>
<p><span class="arg">self.</span>undercolor= <span class=
- "arg">aString</span> or <span class="arg">aPixel</span></p>
+ "arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1328,18 +1357,18 @@
with the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
- <a href="struct.html#Pixel">aPixel</a>.</p>
+ <a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="units">units</h3>
<p><span class="arg">self.</span>units= <span class=
- "arg">aResolutionType</span></p>
+ "arg">unit</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1353,10 +1382,10 @@
<div class="sig">
<h3 id="view">view</h3>
<p><span class="arg">self.</span>view= <span class=
- "arg">aString</span></p>
+ "arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>