diff --git a/src/modules/Image/doc/Image.font.html b/src/modules/Image/doc/Image.font.html
index 28fc41938a29a1f30849dea2d20c74c252b0d50a..1f8b59acc7476cded97461b1cdfb939b7565a7db 100644
--- a/src/modules/Image/doc/Image.font.html
+++ b/src/modules/Image/doc/Image.font.html
@@ -3,8 +3,23 @@
<blockquote>
+This object adds the text-drawing and -creation
+ capabilities of the <tt><a href=Image.html>Image</a></tt> module.
- Short technical documentation on a font file:
+<p> For simple usage, see
+ <tt><a href=Image.font.html#write>write</a></tt> and <tt><a href=Image.font.html#load>load</a></tt>.
+
+<p> other methods: <tt><a href=Image.font.html#baseline>baseline</a></tt>,
+ <tt><a href=Image.font.html#height>height</a></tt>,
+ <tt><a href=Image.font.html#set_xspacing_scale>set_xspacing_scale</a></tt>,
+ <tt><a href=Image.font.html#set_yspacing_scale>set_yspacing_scale</a></tt>,
+ <tt><a href=Image.font.html#text_extents>text_extents</a></tt>
+</blockquote>
+
+
+<h4>NOTE</h4>
+<blockquote>
+Short technical documentation on a font file:
<pre>
struct file_head
{
@@ -22,20 +37,16 @@
unsigned char data[1]; - pixmap data (1byte/pixel)
} *ch;
</pre>
-
</blockquote>
-<hr>
- <i><tt><tt><a href=#>baseline</a></tt></tt></i><br>
- <i><tt><tt><a href=#>height</a></tt></tt></i><br>
- <i><tt><tt><a href=#>load</a></tt></tt></i><br>
- <i><tt><tt><a href=#>set_xspacing_scale</a></tt></tt></i><br>
- <i><tt><tt><a href=#>set_yspacing_scale</a></tt></tt></i><br>
- <i><tt><tt><a href=#>text_extents</a></tt></tt></i><br>
- <i><tt><tt><a href=#>write</a></tt></tt></i><br>
+<h4>SEE ALSO</h4>
+<blockquote> <tt><a href=Image.html>Image</a></tt>,
+ <tt><a href=Image.image.html>Image.image</a></tt>
+</blockquote>
<hr>
+<a name=baseline> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>int <b>baseline</b>()</tt>
@@ -50,15 +61,17 @@ font baseline (pixels from top)
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>height</a></tt>,
- <tt><a href=#>text_extents</a></tt>
+<blockquote> <tt><a href=Image.font.html#height>height</a></tt>,
+ <tt><a href=Image.font.html#text_extents>text_extents</a></tt>
</blockquote>
<hr>
+<a name=height> </a>
+<a name=text_extents> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>int <b>height</b>()<br>
-array(int) <b>text_extents</b>(string text, ...)</tt>
+array(int) <b>text_extents</b>(string text, ...)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -66,7 +79,7 @@ array(int) <b>text_extents</b>(string text, ...)</tt>
<blockquote>
Calculate extents of a text-image,
- that would be created by calling <tt><a href=#>write</a></tt>
+ that would be created by calling <tt><a href=Image.font.html#write>write</a></tt>
with the same arguments.
</blockquote>
<h4>ARGUMENTS</h4>
@@ -83,15 +96,16 @@ an array of width and height
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>write</a></tt>,
- <tt><a href=#>height</a></tt>,
- <tt><a href=#>baseline</a></tt>
+<blockquote> <tt><a href=Image.font.html#write>write</a></tt>,
+ <tt><a href=Image.font.html#height>height</a></tt>,
+ <tt><a href=Image.font.html#baseline>baseline</a></tt>
</blockquote>
<hr>
+<a name=load> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object|int <b>load</b>(string filename)</tt>
+<tt>object|int <b>load</b>(string filename)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -114,14 +128,16 @@ zero upon failure, font object upon success
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>write</a></tt>
+<blockquote> <tt><a href=Image.font.html#write>write</a></tt>
</blockquote>
<hr>
+<a name=set_xspacing_scale> </a>
+<a name=set_yspacing_scale> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>void <b>set_xspacing_scale</b>(float scale)<br>
-void <b>set_yspacing_scale</b>(float scale)</tt>
+<tt>void <b>set_xspacing_scale</b>(float scale)<br>
+void <b>set_yspacing_scale</b>(float scale)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -139,9 +155,10 @@ Set spacing scale to write characters closer
</dl></blockquote>
<hr>
+<a name=write> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>write</b>(string text, ...)</tt>
+<tt>object <b>write</b>(string text, ...)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -165,8 +182,8 @@ an <ref>Image::image</ref> object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>text_extents</a></tt>,
- <tt><a href=#>load</a></tt>,
- <tt><a href=#>image::paste_mask</a></tt>,
- <tt><a href=#>image::paste_alpha_color</a></tt>
+<blockquote> <tt><a href=Image.font.html#text_extents>text_extents</a></tt>,
+ <tt><a href=Image.font.html#load>load</a></tt>,
+ <tt><a href=Image.image.html#paste_mask>image::paste_mask</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>image::paste_alpha_color</a></tt>
</blockquote>
diff --git a/src/modules/Image/doc/Image.html b/src/modules/Image/doc/Image.html
index 7d7474f5e828b7f87f32595a3366d8c2b1e12d7b..6a8db1176147ab8204a5ffe68781c353ba3dc901 100644
--- a/src/modules/Image/doc/Image.html
+++ b/src/modules/Image/doc/Image.html
@@ -1,6 +1,18 @@
<title>Pike documentation: module Image</title>
<h2>module Image</h2>
+
+
+<blockquote>
+This module adds image-drawing and -manipulating
+ capabilities to pike.
+</blockquote>
+
+
+<h4>SEE ALSO</h4>
+<blockquote> <tt><a href=Image.font.html>Image.font</a></tt>,
+ <tt><a href=Image.image.html>Image.image</a></tt>
+</blockquote>
<h3>More documentation:</h3>
- <i><tt><tt><a href=#>Image.font</a></tt></tt></i><br>
- <i><tt><tt><a href=#>Image.image</a></tt></tt></i>
+ <i><tt><a href=Image.font.html>Image.font</a></tt></tt></i><br>
+ <i><tt><tt><a href=Image.image.html>Image.image</a></tt></i>
diff --git a/src/modules/Image/doc/Image.image.html b/src/modules/Image/doc/Image.image.html
index 6625302dddd71a6f59a128da39be7408dabf6b0a..c2e8bed3231fc323d61704f71957ceaa94b2cb2a 100644
--- a/src/modules/Image/doc/Image.image.html
+++ b/src/modules/Image/doc/Image.image.html
@@ -1,82 +1,99 @@
<title>Pike documentation: Image.image</title>
<h2>Image.image</h2>
-<hr>
- <i><tt><tt><a href=#>`&</a></tt></tt></i><br>
- <i><tt><tt><a href=#>`*</a></tt></tt></i><br>
- <i><tt><tt><a href=#>`+</a></tt></tt></i><br>
- <i><tt><tt><a href=#>`-</a></tt></tt></i><br>
- <i><tt><tt><a href=#>`|</a></tt></tt></i><br>
- <i><tt><tt><a href=#>add_layers</a></tt></tt></i><br>
- <i><tt><tt><a href=#>apply_matrix</a></tt></tt></i><br>
- <i><tt><tt><a href=#>autocrop</a></tt></tt></i><br>
- <i><tt><tt><a href=#>box</a></tt></tt></i><br>
- <i><tt><tt><a href=#>cast</a></tt></tt></i><br>
- <i><tt><tt><a href=#>ccw</a></tt></tt></i><br>
- <i><tt><tt><a href=#>change_color</a></tt></tt></i><br>
- <i><tt><tt><a href=#>circle</a></tt></tt></i><br>
- <i><tt><tt><a href=#>clear</a></tt></tt></i><br>
- <i><tt><tt><a href=#>clone</a></tt></tt></i><br>
- <i><tt><tt><a href=#>color</a></tt></tt></i><br>
- <i><tt><tt><a href=#>copy</a></tt></tt></i><br>
- <i><tt><tt><a href=#>create</a></tt></tt></i><br>
- <i><tt><tt><a href=#>cw</a></tt></tt></i><br>
- <i><tt><tt><a href=#>dct</a></tt></tt></i><br>
- <i><tt><tt><a href=#>distancesq</a></tt></tt></i><br>
- <i><tt><tt><a href=#>fromgif</a></tt></tt></i><br>
- <i><tt><tt><a href=#>frompnm</a></tt></tt></i><br>
- <i><tt><tt><a href=#>fromppm</a></tt></tt></i><br>
- <i><tt><tt><a href=#>getpixel</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_add</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_add_fs</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_add_fs_nomap</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_add_nomap</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_begin</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_end</a></tt></tt></i><br>
- <i><tt><tt><a href=#>gif_netscape_loop</a></tt></tt></i><br>
- <i><tt><tt><a href=#>grey</a></tt></tt></i><br>
- <i><tt><tt><a href=#>invert</a></tt></tt></i><br>
- <i><tt><tt><a href=#>line</a></tt></tt></i><br>
- <i><tt><tt><a href=#>map_closest</a></tt></tt></i><br>
- <i><tt><tt><a href=#>map_fast</a></tt></tt></i><br>
- <i><tt><tt><a href=#>mirrorx</a></tt></tt></i><br>
- <i><tt><tt><a href=#>modify_by_intensity</a></tt></tt></i><br>
- <i><tt><tt><a href=#>paste</a></tt></tt></i><br>
- <i><tt><tt><a href=#>paste_alpha</a></tt></tt></i><br>
- <i><tt><tt><a href=#>paste_alpha_color</a></tt></tt></i><br>
- <i><tt><tt><a href=#>paste_mask</a></tt></tt></i><br>
- <i><tt><tt><a href=#>rotate</a></tt></tt></i><br>
- <i><tt><tt><a href=#>rotate_expand</a></tt></tt></i><br>
- <i><tt><tt><a href=#>scale</a></tt></tt></i><br>
- <i><tt><tt><a href=#>select_from</a></tt></tt></i><br>
- <i><tt><tt><a href=#>setcolor</a></tt></tt></i><br>
- <i><tt><tt><a href=#>setpixel</a></tt></tt></i><br>
- <i><tt><tt><a href=#>skewx</a></tt></tt></i><br>
- <i><tt><tt><a href=#>skewx_expand</a></tt></tt></i><br>
- <i><tt><tt><a href=#>skewy</a></tt></tt></i><br>
- <i><tt><tt><a href=#>skewy_expand</a></tt></tt></i><br>
- <i><tt><tt><a href=#>to8bit</a></tt></tt></i><br>
- <i><tt><tt><a href=#>to8bit_closest</a></tt></tt></i><br>
- <i><tt><tt><a href=#>to8bit_fs</a></tt></tt></i><br>
- <i><tt><tt><a href=#>to8bit_rgbcube</a></tt></tt></i><br>
- <i><tt><tt><a href=#>to8bit_rgbcube_rdither</a></tt></tt></i><br>
- <i><tt><tt><a href=#>tobitmap</a></tt></tt></i><br>
- <i><tt><tt><a href=#>togif</a></tt></tt></i><br>
- <i><tt><tt><a href=#>togif_fs</a></tt></tt></i><br>
- <i><tt><tt><a href=#>toppm</a></tt></tt></i><br>
- <i><tt><tt><a href=#>tozbgr</a></tt></tt></i><br>
- <i><tt><tt><a href=#>treshold</a></tt></tt></i><br>
- <i><tt><tt><a href=#>tuned_box</a></tt></tt></i><br>
- <i><tt><tt><a href=#>xsize</a></tt></tt></i><br>
- <i><tt><tt><a href=#>ysize</a></tt></tt></i><br>
+
+<blockquote>
+The main object of the <tt><a href=Image.html>Image</a></tt> module, this object
+ is used as drawing area, mask or result of operations.
+
+<p> init: <tt><a href=Image.image.html#clear>clear</a></tt>,
+ <tt><a href=Image.image.html#clone>clone</a></tt>,
+ <tt><a href=Image.image.html#create>create</a></tt>,
+ <tt><a href=Image.image.html#xsize>xsize</a></tt>,
+ <tt><a href=Image.image.html#ysize>ysize</a></tt>
+
+<p> plain drawing: <tt><a href=Image.image.html#box>box</a></tt>,
+ <tt><a href=Image.image.html#circle>circle</a></tt>,
+ <tt><a href=Image.image.html#getpixel>getpixel</a></tt>,
+ <tt><a href=Image.image.html#line>line</a></tt>,
+ <tt><a href=Image.image.html#setcolor>setcolor</a></tt>,
+ <tt><a href=Image.image.html#setpixel>setpixel</a></tt>,
+ <tt><a href=Image.image.html#treshold>treshold</a></tt>,
+ <tt><a href=Image.image.html#tuned_box>tuned_box</a></tt>
+
+<p> operators: <tt><a href=Image.image.html#%60%26>`&</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#%60+>`+</a></tt>,
+ <tt><a href=Image.image.html#%60->`-</a></tt>,
+ <tt><a href=Image.image.html#%60|>`|</a></tt>
+
+<p> pasting images, layers: <tt><a href=Image.image.html#add_layers>add_layers</a></tt>,
+ <tt><a href=Image.image.html#paste>paste</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha>paste_alpha</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>,
+ <tt><a href=Image.image.html#paste_mask>paste_mask</a></tt>
+
+<p> getting subimages, scaling, rotating: <tt><a href=Image.image.html#autocrop>autocrop</a></tt>,
+ <tt><a href=Image.image.html#ccw>ccw</a></tt>,
+ <tt><a href=Image.image.html#cw>cw</a></tt>,
+ <tt><a href=Image.image.html#clone>clone</a></tt>,
+ <tt><a href=Image.image.html#copy>copy</a></tt>,
+ <tt><a href=Image.image.html#dct>dct</a></tt>,
+ <tt><a href=Image.image.html#mirrorx>mirrorx</a></tt>,
+ <tt><a href=Image.image.html#rotate>rotate</a></tt>,
+ <tt><a href=Image.image.html#rotate_expand>rotate_expand</a></tt>,
+ <tt><a href=Image.image.html#scale>scale</a></tt>,
+ <tt><a href=Image.image.html#skewx>skewx</a></tt>,
+ <tt><a href=Image.image.html#skewx_expand>skewx_expand</a></tt>,
+ <tt><a href=Image.image.html#skewy>skewy</a></tt>,
+ <tt><a href=Image.image.html#skewy_expand>skewy_expand</a></tt>
+
+<p> calculation by pixels: <tt><a href=Image.image.html#apply_matrix>apply_matrix</a></tt>,
+ <tt><a href=Image.image.html#change_color>change_color</a></tt>,
+ <tt><a href=Image.image.html#color>color</a></tt>,
+ <tt><a href=Image.image.html#distancesq>distancesq</a></tt>,
+ <tt><a href=Image.image.html#grey>grey</a></tt>,
+ <tt><a href=Image.image.html#invert>invert</a></tt>,
+ <tt><a href=Image.image.html#map_closest>map_closest</a></tt>,
+ <tt><a href=Image.image.html#map_fast>map_fast</a></tt>,
+ <tt><a href=Image.image.html#modify_by_intensity>modify_by_intensity</a></tt>,
+ <tt><a href=Image.image.html#select_from>select_from</a></tt>
+
+<p> converting to other datatypes: <tt><a href=Image.image.html#cast>cast</a></tt>,
+ <tt><a href=Image.image.html#fromgif>fromgif</a></tt>,
+ <tt><a href=Image.image.html#frompnm>frompnm</a></tt>/<tt><a href=Image.image.html#fromppm>fromppm</a></tt>,
+ <tt><a href=Image.image.html#gif_add>gif_add</a></tt>,
+ <tt><a href=Image.image.html#gif_add_fs>gif_add_fs</a></tt>,
+ <tt><a href=Image.image.html#gif_add_fs_nomap>gif_add_fs_nomap</a></tt>,
+ <tt><a href=Image.image.html#gif_add_nomap>gif_add_nomap</a></tt>,
+ <tt><a href=Image.image.html#gif_begin>gif_begin</a></tt>,
+ <tt><a href=Image.image.html#gif_end>gif_end</a></tt>,
+ <tt><a href=Image.image.html#gif_netscape_loop>gif_netscape_loop</a></tt>,
+ <tt><a href=Image.image.html#to8bit>to8bit</a></tt>,
+ <tt><a href=Image.image.html#to8bit_closest>to8bit_closest</a></tt>,
+ <tt><a href=Image.image.html#to8bit_fs>to8bit_fs</a></tt>,
+ <tt><a href=Image.image.html#to8bit_rgbcube>to8bit_rgbcube</a></tt>,
+ <tt><a href=Image.image.html#to8bit_rgbcube_rdither>to8bit_rgbcube_rdither</a></tt>,
+ <tt><a href=Image.image.html#tobitmap>tobitmap</a></tt>,
+ <tt><a href=Image.image.html#togif>togif</a></tt>,
+ <tt><a href=Image.image.html#togif_fs>togif_fs</a></tt>,
+ <tt><a href=Image.image.html#toppm>toppm</a></tt>,
+ <tt><a href=Image.image.html#tozbgr>tozbgr</a></tt>
+</blockquote>
+<h4>SEE ALSO</h4>
+<blockquote> <tt><a href=Image.html>Image</a></tt>,
+ <tt><a href=Image.font.html>Image.font</a></tt>
+</blockquote>
+
<hr>
+<a name=%60%26> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>`&</b>(object operand)<br>
-object <b>`&</b>(array(int) color)<br>
-object <b>`&</b>(int value)</tt>
+<tt>object <b>`&</b>(object operand)<br>
+object <b>`&</b>(array(int) color)<br>
+object <b>`&</b>(int value)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -104,19 +121,20 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>`-</a></tt>,
- <tt><a href=#>`+</a></tt>,
- <tt><a href=#>`|</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>add_layers</a></tt>
+<blockquote> <tt><a href=Image.image.html#%60->`-</a></tt>,
+ <tt><a href=Image.image.html#%60+>`+</a></tt>,
+ <tt><a href=Image.image.html#%60|>`|</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#add_layers>add_layers</a></tt>
</blockquote>
<hr>
+<a name=%60*> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>`*</b>(object operand)<br>
-object <b>`*</b>(array(int) color)<br>
-object <b>`*</b>(int value)</tt>
+<tt>object <b>`*</b>(object operand)<br>
+object <b>`*</b>(array(int) color)<br>
+object <b>`*</b>(int value)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -148,19 +166,20 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>`-</a></tt>,
- <tt><a href=#>`+</a></tt>,
- <tt><a href=#>`|</a></tt>,
- <tt><a href=#>`&</a></tt>,
- <tt><a href=#>add_layers</a></tt>
+<blockquote> <tt><a href=Image.image.html#%60->`-</a></tt>,
+ <tt><a href=Image.image.html#%60+>`+</a></tt>,
+ <tt><a href=Image.image.html#%60|>`|</a></tt>,
+ <tt><a href=Image.image.html#%60%26>`&</a></tt>,
+ <tt><a href=Image.image.html#add_layers>add_layers</a></tt>
</blockquote>
<hr>
+<a name=%60+> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>`+</b>(object operand)<br>
-object <b>`+</b>(array(int) color)<br>
-object <b>`+</b>(int value)</tt>
+<tt>object <b>`+</b>(object operand)<br>
+object <b>`+</b>(array(int) color)<br>
+object <b>`+</b>(int value)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -186,19 +205,20 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>`-</a></tt>,
- <tt><a href=#>`|</a></tt>,
- <tt><a href=#>`&</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>add_layers</a></tt>
+<blockquote> <tt><a href=Image.image.html#%60->`-</a></tt>,
+ <tt><a href=Image.image.html#%60|>`|</a></tt>,
+ <tt><a href=Image.image.html#%60%26>`&</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#add_layers>add_layers</a></tt>
</blockquote>
<hr>
+<a name=%60-> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>`-</b>(object operand)<br>
-object <b>`-</b>(array(int) color)<br>
-object <b>`-</b>(int value)</tt>
+<tt>object <b>`-</b>(object operand)<br>
+object <b>`-</b>(array(int) color)<br>
+object <b>`-</b>(int value)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -225,19 +245,20 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>`+</a></tt>,
- <tt><a href=#>`|</a></tt>,
- <tt><a href=#>`&</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>add_layers</a></tt>
+<blockquote> <tt><a href=Image.image.html#%60+>`+</a></tt>,
+ <tt><a href=Image.image.html#%60|>`|</a></tt>,
+ <tt><a href=Image.image.html#%60%26>`&</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#add_layers>add_layers</a></tt>
</blockquote>
<hr>
+<a name=%60|> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>`|</b>(object operand)<br>
-object <b>`|</b>(array(int) color)<br>
-object <b>`|</b>(int value)</tt>
+<tt>object <b>`|</b>(object operand)<br>
+object <b>`|</b>(array(int) color)<br>
+object <b>`|</b>(int value)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -265,18 +286,19 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>`-</a></tt>,
- <tt><a href=#>`+</a></tt>,
- <tt><a href=#>`&</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>add_layers</a></tt>
+<blockquote> <tt><a href=Image.image.html#%60->`-</a></tt>,
+ <tt><a href=Image.image.html#%60+>`+</a></tt>,
+ <tt><a href=Image.image.html#%60%26>`&</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#add_layers>add_layers</a></tt>
</blockquote>
<hr>
+<a name=add_layers> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>add_layers</b>(array(int|object)) layer0, ...)<br>
-object <b>add_layers</b>(int x1, int y1, int x2, int y2, array(int|object)) layer0, ...)</tt>
+<tt>object <b>add_layers</b>(array(int|object)) layer0, ...)<br>
+object <b>add_layers</b>(int x1, int y1, int x2, int y2, array(int|object)) layer0, ...)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -303,7 +325,7 @@ Using the called object as base, adds layers using masks,
<pre>
0 no operation (just paste with mask, default)
1 maximum (`|)
- 2 minimum (`&)
+ 2 minimum (`&)
3 multiply (`*)
4 add (`+)
5 diff (`-)
@@ -317,12 +339,12 @@ Using the called object as base, adds layers using masks,
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>array(int|object) layer0</tt>
- <dd>image to paste
<dt><tt>int x1</tt>
<dt><tt>int y1</tt>
<dt><tt>int x2</tt>
<dt><tt>int y2</tt>
- <dd>rectangle for cropping
+ <dd>image to paste
+ rectangle for cropping
</dl></blockquote>
<h4>RETURNS</h4>
@@ -333,22 +355,23 @@ a new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>paste_mask</a></tt>,
- <tt><a href=#>paste_alpha</a></tt>,
- <tt><a href=#>paste_alpha_color</a></tt>,
- <tt><a href=#>`|</a></tt>,
- <tt><a href=#>`&</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>`+</a></tt>,
- <tt><a href=#>`-</a></tt>
+<blockquote> <tt><a href=Image.image.html#paste_mask>paste_mask</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha>paste_alpha</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>,
+ <tt><a href=Image.image.html#%60|>`|</a></tt>,
+ <tt><a href=Image.image.html#%60%26>`&</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#%60+>`+</a></tt>,
+ <tt><a href=Image.image.html#%60->`-</a></tt>
</blockquote>
<hr>
+<a name=apply_matrix> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>apply_matrix</b>(array(array(int|array(int))) matrix)<br>
-object <b>apply_matrix</b>(array(array(int|array(int))) matrix, int r, int g, int b)<br>
-object <b>apply_matrix</b>(array(array(int|array(int))) matrix, int r, int g, int b, int|float div)</tt>
+<tt>object <b>apply_matrix</b>(array(array(int|array(int))) matrix)<br>
+object <b>apply_matrix</b>(array(array(int|array(int))) matrix, int r, int g, int b)<br>
+object <b>apply_matrix</b>(array(array(int|array(int))) matrix, int r, int g, int b, int|float div)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -394,7 +417,7 @@ Applies a pixel-transform matrix, or filter, to the image.
({0, 0,0})})
</pre>
-<p> emboss (might prefer to begin with a <tt><a href=#>grey</a></tt> image):
+<p> emboss (might prefer to begin with a <tt><a href=Image.image.html#grey>grey</a></tt> image):
<pre>
({({2, 1, 0})
({1, 0,-1}),
@@ -407,14 +430,14 @@ Applies a pixel-transform matrix, or filter, to the image.
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>array(array(int|array(int)))</tt>
- <dd>the matrix; innermost is a value or an array with red, green, blue
- values for red, green, blue separation.
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>base level of result, default is zero
<dt><tt>int|float div</tt>
- <dd>division factor, default is 1.0.
+ <dd>the matrix; innermost is a value or an array with red, green, blue
+ values for red, green, blue separation.
+ base level of result, default is zero
+ division factor, default is 1.0.
</dl></blockquote>
<h4>RETURNS</h4>
@@ -424,13 +447,14 @@ the new image object
</blockquote>
<hr>
+<a name=autocrop> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>autocrop</b>()<br>
-object <b>autocrop</b>(int border)<br>
-object <b>autocrop</b>(int border, int r, int g, int b)<br>
-object <b>autocrop</b>(int border, int left, int right, int top, int bottom)<br>
-object <b>autocrop</b>(int border, int left, int right, int top, int bottom, int r, int g, int b)</tt>
+object <b>autocrop</b>(int border)<br>
+object <b>autocrop</b>(int border, int r, int g, int b)<br>
+object <b>autocrop</b>(int border, int left, int right, int top, int bottom)<br>
+object <b>autocrop</b>(int border, int left, int right, int top, int bottom, int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -446,16 +470,16 @@ Removes "unneccesary" borders around the image, adds one of
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int border</tt>
- <dd>added border size in pixels
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color of the new border
<dt><tt>int left</tt>
<dt><tt>int right</tt>
<dt><tt>int top</tt>
<dt><tt>int bottom</tt>
- <dd>which borders to scan and cut the image;
+ <dd>added border size in pixels
+ color of the new border
+ which borders to scan and cut the image;
a typical example is removing the top and bottom unneccesary
pixels:
<pre>img=img->autocrop(0, 0,0,1,1);</pre>
@@ -469,15 +493,16 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>copy</a></tt>
+<blockquote> <tt><a href=Image.image.html#copy>copy</a></tt>
</blockquote>
<hr>
+<a name=box> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>box</b>(int x1, int y1, int x2, int y2)<br>
-object <b>box</b>(int x1, int y1, int x2, int y2, int r, int g, int b)<br>
-object <b>box</b>(int x1, int y1, int x2, int y2, int r, int g, int b, int alpha)</tt>
+<tt>object <b>box</b>(int x1, int y1, int x2, int y2)<br>
+object <b>box</b>(int x1, int y1, int x2, int y2, int r, int g, int b)<br>
+object <b>box</b>(int x1, int y1, int x2, int y2, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -492,13 +517,13 @@ Draws a filled rectangle on the image.
<dt><tt>int y1</tt>
<dt><tt>int x2</tt>
<dt><tt>int y2</tt>
- <dd>box corners
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color of the box
<dt><tt>int alpha</tt>
- <dd>alpha value
+ <dd>box corners
+ color of the box
+ alpha value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -508,9 +533,10 @@ the object called
</blockquote>
<hr>
+<a name=cast> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>string <b>cast</b>(string type)</tt>
+<tt>string <b>cast</b>(string type)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -528,14 +554,15 @@ the image data as a string ("rgbrgbrgb...")
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>toppm</a></tt>,
- <tt><a href=#>togif</a></tt>,
- <tt><a href=#>tozbgr</a></tt>,
- <tt><a href=#>to8bit</a></tt>,
- <tt><a href=#>to8bit_rgbcube</a></tt>
+<blockquote> <tt><a href=Image.image.html#toppm>toppm</a></tt>,
+ <tt><a href=Image.image.html#togif>togif</a></tt>,
+ <tt><a href=Image.image.html#tozbgr>tozbgr</a></tt>,
+ <tt><a href=Image.image.html#to8bit>to8bit</a></tt>,
+ <tt><a href=Image.image.html#to8bit_rgbcube>to8bit_rgbcube</a></tt>
</blockquote>
<hr>
+<a name=ccw> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>ccw</b>()</tt>
@@ -555,10 +582,11 @@ the new image object
</blockquote>
<hr>
+<a name=change_color> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>change_color</b>(int tor, int tog, int tob)<br>
-object <b>change_color</b>(int fromr, int fromg, int fromb,  int tor, int tog, int tob)</tt>
+<tt>object <b>change_color</b>(int tor, int tog, int tob)<br>
+object <b>change_color</b>(int fromr, int fromg, int fromb, int tor, int tog, int tob)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -566,19 +594,19 @@ object <b>change_color</b>(int fromr, int fromg, int fromb,  int
<blockquote>
Changes one color (exakt match) to another.
- If non-exakt-match is preferred, check <tt><a href=#>distancesq</a></tt>
- and <tt><a href=#>paste_alpha_color</a></tt>.
+ If non-exakt-match is preferred, check <tt><a href=Image.image.html#distancesq>distancesq</a></tt>
+ and <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>.
</blockquote>
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int tor</tt>
<dt><tt>int tog</tt>
<dt><tt>int tob</tt>
- <dd>destination color and next current color
<dt><tt>int fromr</tt>
<dt><tt>int fromg</tt>
<dt><tt>int fromb</tt>
- <dd>source color, default is current color
+ <dd>destination color and next current color
+ source color, default is current color
</dl></blockquote>
<h4>RETURNS</h4>
@@ -588,11 +616,12 @@ a new (the destination) image object
</blockquote>
<hr>
+<a name=circle> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>circle</b>(int x, int y, int rx, int ry)<br>
-object <b>circle</b>(int x, int y, int rx, int ry, int r, int g, int b)<br>
-object <b>circle</b>(int x, int y, int rx, int ry, int r, int g, int b, int alpha)</tt>
+<tt>object <b>circle</b>(int x, int y, int rx, int ry)<br>
+object <b>circle</b>(int x, int y, int rx, int ry, int r, int g, int b)<br>
+object <b>circle</b>(int x, int y, int rx, int ry, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -605,16 +634,16 @@ Draws a line on the image. The line is <i>not</i> antialiased.
<blockquote><dl>
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>circle center
<dt><tt>int rx</tt>
<dt><tt>int ry</tt>
- <dd>circle radius in pixels
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color
<dt><tt>int alpha</tt>
- <dd>alpha value
+ <dd>circle center
+ circle radius in pixels
+ color
+ alpha value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -624,11 +653,12 @@ the object called
</blockquote>
<hr>
+<a name=clear> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>void <b>clear</b>()<br>
-void <b>clear</b>(int r, int g, int b)<br>
-void <b>clear</b>(int r, int g, int b, int alpha)</tt>
+void <b>clear</b>(int r, int g, int b)<br>
+void <b>clear</b>(int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -642,24 +672,25 @@ gives a new, cleared image with the same size of drawing area
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color of the new image
<dt><tt>int alpha</tt>
- <dd>new default alpha channel value
+ <dd>color of the new image
+ new default alpha channel value
</dl></blockquote>
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>copy</a></tt>,
- <tt><a href=#>clone</a></tt>
+<blockquote> <tt><a href=Image.image.html#copy>copy</a></tt>,
+ <tt><a href=Image.image.html#clone>clone</a></tt>
</blockquote>
<hr>
+<a name=clone> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>clone</b>()<br>
-object <b>clone</b>(int xsize, int ysize)<br>
-object <b>clone</b>(int xsize, int ysize, int r, int g, int b)<br>
-object <b>clone</b>(int xsize, int ysize, int r, int g, int b, int alpha)</tt>
+object <b>clone</b>(int xsize, int ysize)<br>
+object <b>clone</b>(int xsize, int ysize, int r, int g, int b)<br>
+object <b>clone</b>(int xsize, int ysize, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -672,17 +703,17 @@ Copies to or initialize a new image object.
<blockquote><dl>
<dt><tt>int xsize</tt>
<dt><tt>int ysize</tt>
- <dd>size of (new) image in pixels, called image
- is cropped to that size
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>current color of the new image,
+<dt><tt>int alpha</tt>
+ <dd>size of (new) image in pixels, called image
+ is cropped to that size
+ current color of the new image,
default is black.
Will also be the background color if the cloned image
is empty (no drawing area made).
-<dt><tt>int alpha</tt>
- <dd>new default alpha channel value
+ new default alpha channel value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -693,16 +724,17 @@ the new object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>copy</a></tt>,
- <tt><a href=#>create</a></tt>
+<blockquote> <tt><a href=Image.image.html#copy>copy</a></tt>,
+ <tt><a href=Image.image.html#create>create</a></tt>
</blockquote>
<hr>
+<a name=color> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>color</b>()<br>
-object <b>color</b>(int value)<br>
-object <b>color</b>(int r, int g, int b)</tt>
+object <b>color</b>(int value)<br>
+object <b>color</b>(int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -723,9 +755,9 @@ Colorize an image.
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>red, green, blue factors
<dt><tt>int value</tt>
- <dd>factor
+ <dd>red, green, blue factors
+ factor
</dl></blockquote>
<h4>RETURNS</h4>
@@ -736,18 +768,19 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>grey</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>modify_by_intensity</a></tt>
+<blockquote> <tt><a href=Image.image.html#grey>grey</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#modify_by_intensity>modify_by_intensity</a></tt>
</blockquote>
<hr>
+<a name=copy> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>copy</b>()<br>
-object <b>copy</b>(int x1, int y1, int x2, int y2)<br>
-object <b>copy</b>(int x1, int y1, int x2, int y2, int r, int g, int b)<br>
-object <b>copy</b>(int x1, int y1, int x2, int y2, int r, int g, int b, int alpha)</tt>
+object <b>copy</b>(int x1, int y1, int x2, int y2)<br>
+object <b>copy</b>(int x1, int y1, int x2, int y2, int r, int g, int b)<br>
+object <b>copy</b>(int x1, int y1, int x2, int y2, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -764,13 +797,13 @@ Copies this part of the image. The requested area can
<dt><tt>int y1</tt>
<dt><tt>int x2</tt>
<dt><tt>int y2</tt>
- <dd>The requested new area. Default is the old image size.
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color of the new image
<dt><tt>int alpha</tt>
- <dd>new default alpha channel value
+ <dd>The requested new area. Default is the old image size.
+ color of the new image
+ new default alpha channel value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -791,17 +824,18 @@ a new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>clone</a></tt>,
- <tt><a href=#>autocrop</a></tt>
+<blockquote> <tt><a href=Image.image.html#clone>clone</a></tt>,
+ <tt><a href=Image.image.html#autocrop>autocrop</a></tt>
</blockquote>
<hr>
+<a name=create> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>void <b>create</b>()<br>
-void <b>create</b>(int xsize, int ysize)<br>
-void <b>create</b>(int xsize, int ysize, int r, int g, int b)<br>
-void <b>create</b>(int xsize, int ysize, int r, int g, int b, int alpha)</tt>
+void <b>create</b>(int xsize, int ysize)<br>
+void <b>create</b>(int xsize, int ysize, int r, int g, int b)<br>
+void <b>create</b>(int xsize, int ysize, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -814,24 +848,25 @@ Initializes a new image object.
<blockquote><dl>
<dt><tt>int xsize</tt>
<dt><tt>int ysize</tt>
- <dd>size of (new) image in pixels
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>background color (will also be current color),
- default color is black
<dt><tt>int alpha</tt>
- <dd>default alpha channel value
+ <dd>size of (new) image in pixels
+ background color (will also be current color),
+ default color is black
+ default alpha channel value
</dl></blockquote>
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>copy</a></tt>,
- <tt><a href=#>clone</a></tt>,
- <tt><a href=#>Image.image</a></tt>
+<blockquote> <tt><a href=Image.image.html#copy>copy</a></tt>,
+ <tt><a href=Image.image.html#clone>clone</a></tt>,
+ <tt><a href=Image.image.html>Image.image</a></tt>
</blockquote>
<hr>
+<a name=cw> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>cw</b>()</tt>
@@ -851,9 +886,10 @@ the new image object
</blockquote>
<hr>
+<a name=dct> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>dct</b>(int newx, int newy)</tt>
+<tt>object <b>dct</b>(int newx, int newy)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -890,10 +926,11 @@ the new image object
</blockquote>
<hr>
+<a name=distancesq> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>distancesq</b>()<br>
-object <b>distancesq</b>(int r, int g, int b)</tt>
+object <b>distancesq</b>(int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -931,13 +968,14 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>select_from</a></tt>
+<blockquote> <tt><a href=Image.image.html#select_from>select_from</a></tt>
</blockquote>
<hr>
+<a name=fromgif> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>fromgif</b>(string gif)</tt>
+<tt>object <b>fromgif</b>(string gif)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -948,12 +986,12 @@ Reads GIF data to the called image object.
<p> GIF animation delay or loops are ignored,
and the resulting image is the written result.
- known bugs: yes, it does -- it may even do segment overrides...
</blockquote>
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>string pnm</tt>
<dd>pnm data, as a string
+ known bugs: yes, it does -- it may even do segment overrides...
</dl></blockquote>
<h4>RETURNS</h4>
@@ -964,15 +1002,17 @@ the called object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>togif</a></tt>,
- <tt><a href=#>frompnm</a></tt>
+<blockquote> <tt><a href=Image.image.html#togif>togif</a></tt>,
+ <tt><a href=Image.image.html#frompnm>frompnm</a></tt>
</blockquote>
<hr>
+<a name=frompnm> </a>
+<a name=fromppm> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object|string <b>frompnm</b>(string pnm)<br>
-object|string <b>fromppm</b>(string pnm)</tt>
+<tt>object|string <b>frompnm</b>(string pnm)<br>
+object|string <b>fromppm</b>(string pnm)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1000,14 +1040,15 @@ the called object or a hint of what wronged.
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>toppm</a></tt>,
- <tt><a href=#>fromgif</a></tt>
+<blockquote> <tt><a href=Image.image.html#toppm>toppm</a></tt>,
+ <tt><a href=Image.image.html#fromgif>fromgif</a></tt>
</blockquote>
<hr>
+<a name=getpixel> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>array(int) <b>getpixel</b>(int x, int y)</tt>
+<tt>array(int) <b>getpixel</b>(int x, int y)</tt>
</blockquote>
<h4>ARGUMENTS</h4>
@@ -1024,40 +1065,44 @@ color of the requested pixel -- ({int red,int green,int blue})
</blockquote>
<hr>
+<a name=gif_add> </a>
+<a name=gif_add_fs> </a>
+<a name=gif_add_fs_nomap> </a>
+<a name=gif_add_nomap> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>gif_add</b>()<br>
-string <b>gif_add</b>(int x, int y)<br>
-string <b>gif_add</b>(int x, int y, int delay_cs)<br>
-string <b>gif_add</b>(int x, int y, float delay_s)<br>
-string <b>gif_add</b>(int x, int y, int num_colors, int delay_cs)<br>
-string <b>gif_add</b>(int x, int y, int num_colors, float delay_s)<br>
-string <b>gif_add</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
-string <b>gif_add</b>(int x, int y, array(array(int)) colors, float delay_s)<br>
+string <b>gif_add</b>(int x, int y)<br>
+string <b>gif_add</b>(int x, int y, int delay_cs)<br>
+string <b>gif_add</b>(int x, int y, float delay_s)<br>
+string <b>gif_add</b>(int x, int y, int num_colors, int delay_cs)<br>
+string <b>gif_add</b>(int x, int y, int num_colors, float delay_s)<br>
+string <b>gif_add</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
+string <b>gif_add</b>(int x, int y, array(array(int)) colors, float delay_s)<br>
string <b>gif_add_fs</b>()<br>
-string <b>gif_add_fs</b>(int x, int y)<br>
-string <b>gif_add_fs</b>(int x, int y, int delay_cs)<br>
-string <b>gif_add_fs</b>(int x, int y, float delay_s)<br>
-string <b>gif_add_fs</b>(int x, int y, int num_colors, int delay_cs)<br>
-string <b>gif_add_fs</b>(int x, int y, int num_colors, float delay_s)<br>
-string <b>gif_add_fs</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
-string <b>gif_add_fs</b>(int x, int y, array(array(int)) colors, float delay_s)<br>
+string <b>gif_add_fs</b>(int x, int y)<br>
+string <b>gif_add_fs</b>(int x, int y, int delay_cs)<br>
+string <b>gif_add_fs</b>(int x, int y, float delay_s)<br>
+string <b>gif_add_fs</b>(int x, int y, int num_colors, int delay_cs)<br>
+string <b>gif_add_fs</b>(int x, int y, int num_colors, float delay_s)<br>
+string <b>gif_add_fs</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
+string <b>gif_add_fs</b>(int x, int y, array(array(int)) colors, float delay_s)<br>
string <b>gif_add_nomap</b>()<br>
-string <b>gif_add_nomap</b>(int x, int y)<br>
-string <b>gif_add_nomap</b>(int x, int y, int delay_cs)<br>
-string <b>gif_add_nomap</b>(int x, int y, float delay_s)<br>
-string <b>gif_add_nomap</b>(int x, int y, int num_colors, int delay_cs)<br>
-string <b>gif_add_nomap</b>(int x, int y, int num_colors, float delay_s)<br>
-string <b>gif_add_nomap</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
-string <b>gif_add_nomap</b>(int x, int y, array(array(int)) colors, float delay_s)<br>
+string <b>gif_add_nomap</b>(int x, int y)<br>
+string <b>gif_add_nomap</b>(int x, int y, int delay_cs)<br>
+string <b>gif_add_nomap</b>(int x, int y, float delay_s)<br>
+string <b>gif_add_nomap</b>(int x, int y, int num_colors, int delay_cs)<br>
+string <b>gif_add_nomap</b>(int x, int y, int num_colors, float delay_s)<br>
+string <b>gif_add_nomap</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
+string <b>gif_add_nomap</b>(int x, int y, array(array(int)) colors, float delay_s)<br>
string <b>gif_add_fs_nomap</b>()<br>
-string <b>gif_add_fs_nomap</b>(int x, int y)<br>
-string <b>gif_add_fs_nomap</b>(int x, int y, int delay_cs)<br>
-string <b>gif_add_fs_nomap</b>(int x, int y, float delay_s)<br>
-string <b>gif_add_fs_nomap</b>(int x, int y, int num_colors, int delay_cs)<br>
-string <b>gif_add_fs_nomap</b>(int x, int y, int num_colors, float delay_s)<br>
-string <b>gif_add_fs_nomap</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
-string <b>gif_add_fs_nomap</b>(int x, int y, array(array(int)) colors, float delay_s)</tt>
+string <b>gif_add_fs_nomap</b>(int x, int y)<br>
+string <b>gif_add_fs_nomap</b>(int x, int y, int delay_cs)<br>
+string <b>gif_add_fs_nomap</b>(int x, int y, float delay_s)<br>
+string <b>gif_add_fs_nomap</b>(int x, int y, int num_colors, int delay_cs)<br>
+string <b>gif_add_fs_nomap</b>(int x, int y, int num_colors, float delay_s)<br>
+string <b>gif_add_fs_nomap</b>(int x, int y, array(array(int)) colors, int delay_cs)<br>
+string <b>gif_add_fs_nomap</b>(int x, int y, array(array(int)) colors, float delay_s)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1073,15 +1118,15 @@ Makes a GIF (sub)image data chunk, to be placed
<blockquote><dl>
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>the location of this subimage
<dt><tt>int delay_cs</tt>
- <dd>frame delay in centiseconds
<dt><tt>float delay_s</tt>
- <dd>frame delay in seconds
<dt><tt>int num_colors</tt>
- <dd>number of colors to quantize to (default is 256)
<dt><tt>array array(array(int)) colors</tt>
- <dd>colors to map to, format is ({({r,g,b}),({r,g,b}),...}).
+ <dd>the location of this subimage
+ frame delay in centiseconds
+ frame delay in seconds
+ number of colors to quantize to (default is 256)
+ colors to map to, format is ({({r,g,b}),({r,g,b}),...}).
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1092,18 +1137,19 @@ the GIF data
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>gif_add</a></tt>,
- <tt><a href=#>gif_end</a></tt>,
- <tt><a href=#>gif_netscape_loop</a></tt>,
- <tt><a href=#>togif</a></tt>
+<blockquote> <tt><a href=Image.image.html#gif_add>gif_add</a></tt>,
+ <tt><a href=Image.image.html#gif_end>gif_end</a></tt>,
+ <tt><a href=Image.image.html#gif_netscape_loop>gif_netscape_loop</a></tt>,
+ <tt><a href=Image.image.html#togif>togif</a></tt>
</blockquote>
<hr>
+<a name=gif_begin> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>gif_begin</b>()<br>
-string <b>gif_begin</b>(int num_colors)<br>
-string <b>gif_begin</b>(array(array(int)) colors)</tt>
+string <b>gif_begin</b>(int num_colors)<br>
+string <b>gif_begin</b>(array(array(int)) colors)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1129,13 +1175,14 @@ the GIF data
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>gif_add</a></tt>,
- <tt><a href=#>gif_end</a></tt>,
- <tt><a href=#>togif</a></tt>,
- <tt><a href=#>gif_netscape_loop</a></tt>
+<blockquote> <tt><a href=Image.image.html#gif_add>gif_add</a></tt>,
+ <tt><a href=Image.image.html#gif_end>gif_end</a></tt>,
+ <tt><a href=Image.image.html#togif>togif</a></tt>,
+ <tt><a href=Image.image.html#gif_netscape_loop>gif_netscape_loop</a></tt>
</blockquote>
<hr>
+<a name=gif_end> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>gif_end</b>()</tt>
@@ -1156,14 +1203,15 @@ the GIF data.
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>gif_begin</a></tt>
+<blockquote> <tt><a href=Image.image.html#gif_begin>gif_begin</a></tt>
</blockquote>
<hr>
+<a name=gif_netscape_loop> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>gif_netscape_loop</b>()<br>
-string <b>gif_netscape_loop</b>(int loops)</tt>
+string <b>gif_netscape_loop</b>(int loops)</tt>
</blockquote>
<h4>ARGUMENTS</h4>
@@ -1180,16 +1228,17 @@ a gif chunk that defines that the GIF animation should loop
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>gif_add</a></tt>,
- <tt><a href=#>gif_begin</a></tt>,
- <tt><a href=#>gif_end</a></tt>
+<blockquote> <tt><a href=Image.image.html#gif_add>gif_add</a></tt>,
+ <tt><a href=Image.image.html#gif_begin>gif_begin</a></tt>,
+ <tt><a href=Image.image.html#gif_end>gif_end</a></tt>
</blockquote>
<hr>
+<a name=grey> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>grey</b>()<br>
-object <b>grey</b>(int r, int g, int b)</tt>
+object <b>grey</b>(int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1215,12 +1264,13 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>color</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>modify_by_intensity</a></tt>
+<blockquote> <tt><a href=Image.image.html#color>color</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#modify_by_intensity>modify_by_intensity</a></tt>
</blockquote>
<hr>
+<a name=invert> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>invert</b>()</tt>
@@ -1241,11 +1291,12 @@ the new image object
</blockquote>
<hr>
+<a name=line> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>line</b>(int x1, int y1, int x2, int y2)<br>
-object <b>line</b>(int x1, int y1, int x2, int y2, int r, int g, int b)<br>
-object <b>line</b>(int x1, int y1, int x2, int y2, int r, int g, int b, int alpha)</tt>
+<tt>object <b>line</b>(int x1, int y1, int x2, int y2)<br>
+object <b>line</b>(int x1, int y1, int x2, int y2, int r, int g, int b)<br>
+object <b>line</b>(int x1, int y1, int x2, int y2, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1260,13 +1311,13 @@ Draws a line on the image. The line is <i>not</i> antialiased.
<dt><tt>int y1</tt>
<dt><tt>int x2</tt>
<dt><tt>int y2</tt>
- <dd>line endpoints
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color
<dt><tt>int alpha</tt>
- <dd>alpha value
+ <dd>line endpoints
+ color
+ alpha value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1276,9 +1327,10 @@ the object called
</blockquote>
<hr>
+<a name=map_closest> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>map_closest</b>(array(array(int)) colors)</tt>
+<tt>object <b>map_closest</b>(array(array(int)) colors)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1305,15 +1357,16 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>map_fast</a></tt>,
- <tt><a href=#>select_colors</a></tt>,
- <tt><a href=#>map_fs</a></tt>
+<blockquote> <tt><a href=Image.image.html#map_fast>map_fast</a></tt>,
+ <tt><a href=Image.image.html#select_colors>select_colors</a></tt>,
+ <tt><a href=Image.image.html#map_fs>map_fs</a></tt>
</blockquote>
<hr>
+<a name=map_closest> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>map_closest</b>(array(array(int)) colors)</tt>
+<tt>object <b>map_closest</b>(array(array(int)) colors)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1343,15 +1396,16 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>map_fast</a></tt>,
- <tt><a href=#>select_colors</a></tt>,
- <tt><a href=#>map_closest</a></tt>
+<blockquote> <tt><a href=Image.image.html#map_fast>map_fast</a></tt>,
+ <tt><a href=Image.image.html#select_colors>select_colors</a></tt>,
+ <tt><a href=Image.image.html#map_closest>map_closest</a></tt>
</blockquote>
<hr>
+<a name=map_closest> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>array(array(int)) <b>map_closest</b>(int num_colors)</tt>
+<tt>array(array(int)) <b>map_closest</b>(int num_colors)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1374,14 +1428,15 @@ an array of colors
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>map_fast</a></tt>,
- <tt><a href=#>select_colors</a></tt>
+<blockquote> <tt><a href=Image.image.html#map_fast>map_fast</a></tt>,
+ <tt><a href=Image.image.html#select_colors>select_colors</a></tt>
</blockquote>
<hr>
+<a name=map_fast> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>map_fast</b>(array(array(int)) colors)</tt>
+<tt>object <b>map_fast</b>(array(array(int)) colors)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1410,11 +1465,12 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>map_fast</a></tt>,
- <tt><a href=#>select_colors</a></tt>
+<blockquote> <tt><a href=Image.image.html#map_fast>map_fast</a></tt>,
+ <tt><a href=Image.image.html#select_colors>select_colors</a></tt>
</blockquote>
<hr>
+<a name=mirrorx> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>mirrorx</b>()</tt>
@@ -1440,6 +1496,7 @@ the new image object
</blockquote>
<hr>
+<a name=mirrorx> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>mirrorx</b>()</tt>
@@ -1459,9 +1516,10 @@ mirrors an image:
</blockquote>
<hr>
+<a name=modify_by_intensity> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>modify_by_intensity</b>(int r, int g, int b, int|array(int) v1, ..., int|array(int) vn)</tt>
+<tt>object <b>modify_by_intensity</b>(int r, int g, int b, int|array(int) v1, ..., int|array(int) vn)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1471,7 +1529,7 @@ mirrors an image:
Recolor an image from intensity values.
<p> For each color an intensity is calculated, from r, g and b factors
- (see <tt><a href=#>grey</a></tt>), this gives a value between 0 and max.
+ (see <tt><a href=Image.image.html#grey>grey</a></tt>), this gives a value between 0 and max.
<p> The color is then calculated from the values given, v1 representing
the intensity value of 0, vn representing max, and colors between
@@ -1482,10 +1540,10 @@ Recolor an image from intensity values.
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>red, green, blue intensity factors
<dt><tt>int|array(int) v1</tt>
<dt><tt>int|array(int) vn</tt>
- <dd>destination color
+ <dd>red, green, blue intensity factors
+ destination color
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1496,16 +1554,17 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>grey</a></tt>,
- <tt><a href=#>`*</a></tt>,
- <tt><a href=#>color</a></tt>
+<blockquote> <tt><a href=Image.image.html#grey>grey</a></tt>,
+ <tt><a href=Image.image.html#%60*>`*</a></tt>,
+ <tt><a href=Image.image.html#color>color</a></tt>
</blockquote>
<hr>
+<a name=paste> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>paste</b>(object image)<br>
-object <b>paste</b>(object image, int x, int y)</tt>
+<tt>object <b>paste</b>(object image)<br>
+object <b>paste</b>(object image, int x, int y)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1517,10 +1576,10 @@ Pastes a given image over the current image.
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>object image</tt>
- <dd>image to paste
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>where to paste the image; default is 0,0
+ <dd>image to paste
+ where to paste the image; default is 0,0
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1531,16 +1590,17 @@ the object called
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>paste_mask</a></tt>,
- <tt><a href=#>paste_alpha</a></tt>,
- <tt><a href=#>paste_alpha_color</a></tt>
+<blockquote> <tt><a href=Image.image.html#paste_mask>paste_mask</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha>paste_alpha</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>
</blockquote>
<hr>
+<a name=paste_alpha> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>paste_alpha</b>(object image, int alpha)<br>
-object <b>paste_alpha</b>(object image, int alpha, int x, int y)</tt>
+<tt>object <b>paste_alpha</b>(object image, int alpha)<br>
+object <b>paste_alpha</b>(object image, int alpha, int x, int y)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1557,12 +1617,12 @@ Pastes a given image over the current image, with
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>object image</tt>
- <dd>image to paste
<dt><tt>int alpha</tt>
- <dd>alpha channel value
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>where to paste the image; default is 0,0
+ <dd>image to paste
+ alpha channel value
+ where to paste the image; default is 0,0
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1573,18 +1633,19 @@ the object called
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>paste_mask</a></tt>,
- <tt><a href=#>paste</a></tt>,
- <tt><a href=#>paste_alpha_color</a></tt>
+<blockquote> <tt><a href=Image.image.html#paste_mask>paste_mask</a></tt>,
+ <tt><a href=Image.image.html#paste>paste</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>
</blockquote>
<hr>
+<a name=paste_alpha_color> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>paste_alpha_color</b>(object mask)<br>
-object <b>paste_alpha_color</b>(object mask, int x, int y)<br>
-object <b>paste_alpha_color</b>(object mask, int r, int g, int b)<br>
-object <b>paste_alpha_color</b>(object mask, int r, int g, int b, int x, int y)</tt>
+<tt>object <b>paste_alpha_color</b>(object mask)<br>
+object <b>paste_alpha_color</b>(object mask, int x, int y)<br>
+object <b>paste_alpha_color</b>(object mask, int r, int g, int b)<br>
+object <b>paste_alpha_color</b>(object mask, int r, int g, int b, int x, int y)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1603,14 +1664,14 @@ Pastes a given color over the current image,
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>object mask</tt>
- <dd>mask image
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>what color to paint with; default is current
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>where to paste the image; default is 0,0
+ <dd>mask image
+ what color to paint with; default is current
+ where to paste the image; default is 0,0
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1621,16 +1682,17 @@ the object called
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>paste_mask</a></tt>,
- <tt><a href=#>paste_alpha</a></tt>,
- <tt><a href=#>paste_alpha_color</a></tt>
+<blockquote> <tt><a href=Image.image.html#paste_mask>paste_mask</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha>paste_alpha</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>
</blockquote>
<hr>
+<a name=paste_mask> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>paste_mask</b>(object image, object mask)<br>
-object <b>paste_mask</b>(object image, object mask, int x, int y)</tt>
+<tt>object <b>paste_mask</b>(object image, object mask)<br>
+object <b>paste_mask</b>(object image, object mask, int x, int y)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1648,12 +1710,12 @@ Pastes a given image over the current image,
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>object image</tt>
- <dd>image to paste
<dt><tt>object mask</tt>
- <dd>mask image
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>where to paste the image; default is 0,0
+ <dd>image to paste
+ mask image
+ where to paste the image; default is 0,0
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1664,18 +1726,20 @@ the object called
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>paste</a></tt>,
- <tt><a href=#>paste_alpha</a></tt>,
- <tt><a href=#>paste_alpha_color</a></tt>
+<blockquote> <tt><a href=Image.image.html#paste>paste</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha>paste_alpha</a></tt>,
+ <tt><a href=Image.image.html#paste_alpha_color>paste_alpha_color</a></tt>
</blockquote>
<hr>
+<a name=rotate> </a>
+<a name=rotate_expand> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>rotate</b>(int|float angle)<br>
-object <b>rotate</b>(int|float angle, int r, int g, int b)<br>
-object <b>rotate_expand</b>(int|float angle)<br>
-object <b>rotate_expand</b>(int|float angle, int r, int g, int b)</tt>
+<tt>object <b>rotate</b>(int|float angle)<br>
+object <b>rotate</b>(int|float angle, int r, int g, int b)<br>
+object <b>rotate_expand</b>(int|float angle)<br>
+object <b>rotate_expand</b>(int|float angle, int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1700,11 +1764,11 @@ Rotates an image a certain amount of degrees (360
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int|float angle</tt>
- <dd>the number of degrees to rotate
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color to fill with; default is current
+ <dd>the number of degrees to rotate
+ color to fill with; default is current
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1714,11 +1778,12 @@ the new image object
</blockquote>
<hr>
+<a name=scale> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>scale</b>(float factor)<br>
+<tt>object <b>scale</b>(float factor)<br>
object <b>scale</b>(0.5)<br>
-object <b>scale</b>(float xfactor, float yfactor)</tt>
+object <b>scale</b>(float xfactor, float yfactor)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1731,10 +1796,10 @@ scales the image with a factor,
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>float factor</tt>
- <dd>factor to use for both x and y
<dt><tt>float xfactor</tt>
<dt><tt>float yfactor</tt>
- <dd>separate factors for x and y
+ <dd>factor to use for both x and y
+ separate factors for x and y
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1744,11 +1809,12 @@ the new image object
</blockquote>
<hr>
+<a name=scale> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>scale</b>(int newxsize, int newysize)<br>
-object <b>scale</b>(0, int newysize)<br>
-object <b>scale</b>(int newxsize, 0)</tt>
+<tt>object <b>scale</b>(int newxsize, int newysize)<br>
+object <b>scale</b>(0, int newysize)<br>
+object <b>scale</b>(int newxsize, 0)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1773,10 +1839,11 @@ the new image object
</blockquote>
<hr>
+<a name=select_from> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>select_from</b>(int x, int y)<br>
-object <b>select_from</b>(int x, int y, int edge_value)</tt>
+<tt>object <b>select_from</b>(int x, int y)<br>
+object <b>select_from</b>(int x, int y, int edge_value)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1790,7 +1857,7 @@ Makes an grey-scale image, for alpha-channel use.
The image is scanned from the given pixel,
filled with 255 if the color is the same,
or 255 minus distance in the colorcube, squared, rightshifted
- 8 steps (see <tt><a href=#>distancesq</a></tt>).
+ 8 steps (see <tt><a href=Image.image.html#distancesq>distancesq</a></tt>).
<p> When the edge distance is reached, the scan is stopped.
Default edge value is 30.
@@ -1812,14 +1879,15 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>distancesq</a></tt>
+<blockquote> <tt><a href=Image.image.html#distancesq>distancesq</a></tt>
</blockquote>
<hr>
+<a name=setcolor> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>setcolor</b>(int r, int g, int b)<br>
-object <b>setcolor</b>(int r, int g, int b, int alpha)</tt>
+<tt>object <b>setcolor</b>(int r, int g, int b)<br>
+object <b>setcolor</b>(int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1833,9 +1901,9 @@ set the current color
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>new color
<dt><tt>int alpha</tt>
- <dd>new alpha value
+ <dd>new color
+ new alpha value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1845,24 +1913,25 @@ the object called
</blockquote>
<hr>
+<a name=setpixel> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>setpixel</b>(int x, int y)<br>
-object <b>setpixel</b>(int x, int y, int r, int g, int b)<br>
-object <b>setpixel</b>(int x, int y, int r, int g, int b, int alpha)</tt>
+<tt>object <b>setpixel</b>(int x, int y)<br>
+object <b>setpixel</b>(int x, int y, int r, int g, int b)<br>
+object <b>setpixel</b>(int x, int y, int r, int g, int b, int alpha)</tt>
</blockquote>
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int x</tt>
<dt><tt>int y</tt>
- <dd>position of the pixel
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color
<dt><tt>int alpha</tt>
- <dd>alpha value
+ <dd>position of the pixel
+ color
+ alpha value
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1872,16 +1941,18 @@ the object called
</blockquote>
<hr>
+<a name=skewx> </a>
+<a name=skewx_expand> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>skewx</b>(int x)<br>
-object <b>skewx</b>(int yfactor)<br>
-object <b>skewx</b>(int x, int r, int g, int b)<br>
-object <b>skewx</b>(int yfactor, int r, int g, int b)<br>
-object <b>skewx_expand</b>(int x)<br>
-object <b>skewx_expand</b>(int yfactor)<br>
-object <b>skewx_expand</b>(int x, int r, int g, int b)<br>
-object <b>skewx_expand</b>(int yfactor, int r, int g, int b)</tt>
+<tt>object <b>skewx</b>(int x)<br>
+object <b>skewx</b>(int yfactor)<br>
+object <b>skewx</b>(int x, int r, int g, int b)<br>
+object <b>skewx</b>(int yfactor, int r, int g, int b)<br>
+object <b>skewx_expand</b>(int x)<br>
+object <b>skewx_expand</b>(int yfactor)<br>
+object <b>skewx_expand</b>(int x, int r, int g, int b)<br>
+object <b>skewx_expand</b>(int yfactor, int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1900,16 +1971,16 @@ Skews an image an amount of pixels or a factor;
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int x</tt>
- <dd>the number of pixels
- The "expand" variant of functions stretches the
- image border pixels rather then filling with
- the given or current color.
<dt><tt>float yfactor</tt>
- <dd>best described as: x=yfactor*this->ysize()
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color to fill with; default is current
+ <dd>the number of pixels
+ The "expand" variant of functions stretches the
+ image border pixels rather then filling with
+ the given or current color.
+ best described as: x=yfactor*this->ysize()
+ color to fill with; default is current
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1919,16 +1990,18 @@ the new image object
</blockquote>
<hr>
+<a name=skewy> </a>
+<a name=skewy_expand> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>skewy</b>(int y)<br>
-object <b>skewy</b>(int xfactor)<br>
-object <b>skewy</b>(int y, int r, int g, int b)<br>
-object <b>skewy</b>(int xfactor, int r, int g, int b)<br>
-object <b>skewy_expand</b>(int y)<br>
-object <b>skewy_expand</b>(int xfactor)<br>
-object <b>skewy_expand</b>(int y, int r, int g, int b)<br>
-object <b>skewy_expand</b>(int xfactor, int r, int g, int b)</tt>
+<tt>object <b>skewy</b>(int y)<br>
+object <b>skewy</b>(int xfactor)<br>
+object <b>skewy</b>(int y, int r, int g, int b)<br>
+object <b>skewy</b>(int xfactor, int r, int g, int b)<br>
+object <b>skewy_expand</b>(int y)<br>
+object <b>skewy_expand</b>(int xfactor)<br>
+object <b>skewy_expand</b>(int y, int r, int g, int b)<br>
+object <b>skewy_expand</b>(int xfactor, int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1953,13 +2026,13 @@ Skews an image an amount of pixels or a factor;
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int y</tt>
- <dd>the number of pixels
<dt><tt>float xfactor</tt>
- <dd>best described as: t=xfactor*this->xsize()
<dt><tt>int r</tt>
<dt><tt>int g</tt>
<dt><tt>int b</tt>
- <dd>color to fill with; default is current
+ <dd>the number of pixels
+ best described as: t=xfactor*this->xsize()
+ color to fill with; default is current
</dl></blockquote>
<h4>RETURNS</h4>
@@ -1969,11 +2042,14 @@ the new image object
</blockquote>
<hr>
+<a name=to8bit> </a>
+<a name=to8bit_closest> </a>
+<a name=to8bit_fs> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>string <b>to8bit</b>(array(array(int)) colors)<br>
-string <b>to8bit_fs</b>(array(array(int)) colors)<br>
-string <b>to8bit_closest</b>(array(array(int)) colors)</tt>
+<tt>string <b>to8bit</b>(array(array(int)) colors)<br>
+string <b>to8bit_fs</b>(array(array(int)) colors)<br>
+string <b>to8bit_closest</b>(array(array(int)) colors)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -1994,22 +2070,25 @@ the calculated string
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>to8bit_rgbcube</a></tt>,
- <tt><a href=#>tozbgr</a></tt>,
- <tt><a href=#>map_fast</a></tt>,
- <tt><a href=#>map_closest</a></tt>,
- <tt><a href=#>select_colors</a></tt>,
- <tt><a href=#>tobitmap</a></tt>
+<blockquote> <tt><a href=Image.image.html#to8bit_rgbcube>to8bit_rgbcube</a></tt>,
+ <tt><a href=Image.image.html#tozbgr>tozbgr</a></tt>,
+ <tt><a href=Image.image.html#map_fast>map_fast</a></tt>,
+ <tt><a href=Image.image.html#map_closest>map_closest</a></tt>,
+ <tt><a href=Image.image.html#select_colors>select_colors</a></tt>,
+ <tt><a href=Image.image.html#tobitmap>tobitmap</a></tt>
</blockquote>
<hr>
+<a name=to8bit_rgbcube> </a>
+<a name=to8bit_rgbcube_rdither> </a>
+<a name=tozbgr> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>string <b>tozbgr</b>(array(array(int)) colors)<br>
-string <b>to8bit_rgbcube</b>(int red, int green, int blue)<br>
-string <b>to8bit_rgbcube</b>(int red, int green, int blue, string map)<br>
-string <b>to8bit_rgbcube_rdither</b>(int red, int green, int blue)<br>
-string <b>to8bit_rgbcube_rdither</b>(int red, int green, int blue, string map)</tt>
+<tt>string <b>tozbgr</b>(array(array(int)) colors)<br>
+string <b>to8bit_rgbcube</b>(int red, int green, int blue)<br>
+string <b>to8bit_rgbcube</b>(int red, int green, int blue, string map)<br>
+string <b>to8bit_rgbcube_rdither</b>(int red, int green, int blue)<br>
+string <b>to8bit_rgbcube_rdither</b>(int red, int green, int blue, string map)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -2026,9 +2105,9 @@ Maps the image into a colorcube with the given
<dt><tt>int red</tt>
<dt><tt>int green</tt>
<dt><tt>int blue</tt>
- <dd>The sides of the colorcube. Not the number of bits!
<dt><tt>string map</tt>
- <dd>Map this position in the colorcube to another value,
+ <dd>The sides of the colorcube. Not the number of bits!
+ Map this position in the colorcube to another value,
ie: say we have position red=1,green=2,blue=3 in a colorcube of
6�6�6, we have the index 1+2*6+3*6*6=121. If the
map-string contains '�' in position 121, the resulting
@@ -2043,12 +2122,13 @@ the calculated string
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>tozbgr</a></tt>,
- <tt><a href=#>to8bit</a></tt>,
- <tt><a href=#>tobitmap</a></tt>
+<blockquote> <tt><a href=Image.image.html#tozbgr>tozbgr</a></tt>,
+ <tt><a href=Image.image.html#to8bit>to8bit</a></tt>,
+ <tt><a href=Image.image.html#tobitmap>tobitmap</a></tt>
</blockquote>
<hr>
+<a name=tobitmap> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>tobitmap</b>();</tt>
@@ -2074,27 +2154,29 @@ the calculated string
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>tozbgr</a></tt>,
- <tt><a href=#>to8bit</a></tt>,
- <tt><a href=#>to8bit_rgbcube</a></tt>,
- <tt><a href=#>cast</a></tt>
+<blockquote> <tt><a href=Image.image.html#tozbgr>tozbgr</a></tt>,
+ <tt><a href=Image.image.html#to8bit>to8bit</a></tt>,
+ <tt><a href=Image.image.html#to8bit_rgbcube>to8bit_rgbcube</a></tt>,
+ <tt><a href=Image.image.html#cast>cast</a></tt>
</blockquote>
<hr>
+<a name=togif> </a>
+<a name=togif_fs> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>togif</b>()<br>
-string <b>togif</b>(int num_colors)<br>
-string <b>togif</b>(array(array(int)) colors)<br>
-string <b>togif</b>(int trans_r, int trans_g, int trans_b)<br>
-string <b>togif</b>(int num_colors, int trans_r, int trans_g, int trans_b)<br>
-string <b>togif</b>(array(array(int)) colors, int trans_r, int trans_g, int trans_b)<br>
+string <b>togif</b>(int num_colors)<br>
+string <b>togif</b>(array(array(int)) colors)<br>
+string <b>togif</b>(int trans_r, int trans_g, int trans_b)<br>
+string <b>togif</b>(int num_colors, int trans_r, int trans_g, int trans_b)<br>
+string <b>togif</b>(array(array(int)) colors, int trans_r, int trans_g, int trans_b)<br>
string <b>togif_fs</b>()<br>
-string <b>togif_fs</b>(int num_colors)<br>
-string <b>togif_fs</b>(array(array(int)) colors)<br>
-string <b>togif_fs</b>(int trans_r, int trans_g, int trans_b)<br>
-string <b>togif_fs</b>(int num_colors, int trans_r, int trans_g, int trans_b)<br>
-string <b>togif_fs</b>(array(array(int)) colors, int trans_r, int trans_g, int trans_b)</tt>
+string <b>togif_fs</b>(int num_colors)<br>
+string <b>togif_fs</b>(array(array(int)) colors)<br>
+string <b>togif_fs</b>(int trans_r, int trans_g, int trans_b)<br>
+string <b>togif_fs</b>(int num_colors, int trans_r, int trans_g, int trans_b)<br>
+string <b>togif_fs</b>(array(array(int)) colors, int trans_r, int trans_g, int trans_b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -2107,13 +2189,13 @@ Makes GIF data. The togif_fs variant uses floyd-steinberg
<h4>ARGUMENTS</h4>
<blockquote><dl>
<dt><tt>int num_colors</tt>
- <dd>number of colors to quantize to (default is 256)
- array array(array(int)) colors
- colors to map to (default is to quantize to 256), format is ({({r,g,b}),({r,g,b}),...}).
<dt><tt>int trans_r</tt>
<dt><tt>int trans_g</tt>
<dt><tt>int trans_b</tt>
- <dd>one color, that is to be transparent.
+ <dd>number of colors to quantize to (default is 256)
+ array array(array(int)) colors
+ colors to map to (default is to quantize to 256), format is ({({r,g,b}),({r,g,b}),...}).
+ one color, that is to be transparent.
</dl></blockquote>
<h4>RETURNS</h4>
@@ -2124,14 +2206,15 @@ the GIF data
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>togif_begin</a></tt>,
- <tt><a href=#>togif_add</a></tt>,
- <tt><a href=#>togif_end</a></tt>,
- <tt><a href=#>toppm</a></tt>,
- <tt><a href=#>fromgif</a></tt>
+<blockquote> <tt><a href=Image.image.html#togif_begin>togif_begin</a></tt>,
+ <tt><a href=Image.image.html#togif_add>togif_add</a></tt>,
+ <tt><a href=Image.image.html#togif_end>togif_end</a></tt>,
+ <tt><a href=Image.image.html#toppm>toppm</a></tt>,
+ <tt><a href=Image.image.html#fromgif>fromgif</a></tt>
</blockquote>
<hr>
+<a name=toppm> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>string <b>toppm</b>()</tt>
@@ -2153,15 +2236,16 @@ PPM data
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>frompnm</a></tt>,
- <tt><a href=#>fromgif</a></tt>
+<blockquote> <tt><a href=Image.image.html#frompnm>frompnm</a></tt>,
+ <tt><a href=Image.image.html#fromgif>fromgif</a></tt>
</blockquote>
<hr>
+<a name=treshold> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>object <b>treshold</b>()<br>
-object <b>treshold</b>(int r, int g, int b)</tt>
+object <b>treshold</b>(int r, int g, int b)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -2195,13 +2279,14 @@ the new image object
<h4>SEE ALSO</h4>
-<blockquote> <tt><a href=#>grey</a></tt>
+<blockquote> <tt><a href=Image.image.html#grey>grey</a></tt>
</blockquote>
<hr>
+<a name=tuned_box> </a>
<h4>SYNOPSIS</h4>
<blockquote>
-<tt>object <b>tuned_box</b>(int x1, int y1, int x2, int y2, array(array(int)) corner_color)</tt>
+<tt>object <b>tuned_box</b>(int x1, int y1, int x2, int y2, array(array(int)) corner_color)</tt>
</blockquote>
<h4>DESCRIPTION</h4>
@@ -2221,9 +2306,9 @@ Draws a filled rectangle with colors (and alpha values) tuned
<dt><tt>int y1</tt>
<dt><tt>int x2</tt>
<dt><tt>int y2</tt>
- <dd>rectangle corners
<dt><tt>array(array(int)) corner_color</tt>
- <dd>colors of the corners:
+ <dd>rectangle corners
+ colors of the corners:
<pre>
({x1y1,x2y1,x1y2,x2y2})
</pre>
@@ -2241,6 +2326,7 @@ the object called
</blockquote>
<hr>
+<a name=xsize> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>int <b>xsize</b>()</tt>
@@ -2254,6 +2340,7 @@ the width of the image
</blockquote>
<hr>
+<a name=ysize> </a>
<h4>SYNOPSIS</h4>
<blockquote>
<tt>int <b>ysize</b>()</tt>
diff --git a/src/modules/Image/font.c b/src/modules/Image/font.c
index 3606cbc376c5a3d21d7d5d489ff67d64e1cf8c22..0f13ee4b231666740e577d4727effb6c23dff54e 100644
--- a/src/modules/Image/font.c
+++ b/src/modules/Image/font.c
@@ -4,6 +4,19 @@
**! module Image
**! class font
**!
+**! This object adds the text-drawing and -creation
+**! capabilities of the <ref>Image</ref> module.
+**!
+**! For simple usage, see
+**! <ref>write</ref> and <ref>load</ref>.
+**!
+**! other methods: <ref>baseline</ref>,
+**! <ref>height</ref>,
+**! <ref>set_xspacing_scale</ref>,
+**! <ref>set_yspacing_scale</ref>,
+**! <ref>text_extents</ref>
+**!
+**! note
**! Short technical documentation on a font file:
**! <pre>
**! struct file_head
@@ -23,9 +36,10 @@
**! } *ch;
**! </pre>
**!
+**! see also: Image, Image.image
*/
-/* $Id: font.c,v 1.8 1997/04/18 06:47:22 mirar Exp $ */
+/* $Id: font.c,v 1.9 1997/04/19 12:33:47 mirar Exp $ */
#include "global.h"
diff --git a/src/modules/Image/image.c b/src/modules/Image/image.c
index aa489b9b3c2052cbcf0361f2eb2205f824c8bd7e..9b8b356be9d439379b07df35988ab7c738dda054 100644
--- a/src/modules/Image/image.c
+++ b/src/modules/Image/image.c
@@ -1,9 +1,93 @@
-/* $Id: image.c,v 1.23 1997/04/18 06:47:26 mirar Exp $ */
+/* $Id: image.c,v 1.24 1997/04/19 12:33:57 mirar Exp $ */
/*
**! module Image
+**!
+**! This module adds image-drawing and -manipulating
+**! capabilities to pike.
+**!
+**! see also: Image.font, Image.image
+**!
**! class image
-*/
+**!
+**! The main object of the <ref>Image</ref> module, this object
+**! is used as drawing area, mask or result of operations.
+**!
+**! init: <ref>clear</ref>,
+**! <ref>clone</ref>,
+**! <ref>create</ref>,
+**! <ref>xsize</ref>,
+**! <ref>ysize</ref>
+**!
+**! plain drawing: <ref>box</ref>,
+**! <ref>circle</ref>,
+**! <ref>getpixel</ref>,
+**! <ref>line</ref>,
+**! <ref>setcolor</ref>,
+**! <ref>setpixel</ref>,
+**! <ref>treshold</ref>,
+**! <ref>tuned_box</ref>
+**!
+**! operators: <ref>`&</ref>,
+**! <ref>`*</ref>,
+**! <ref>`+</ref>,
+**! <ref>`-</ref>,
+**! <ref>`|</ref>
+**!
+**! pasting images, layers: <ref>add_layers</ref>,
+**! <ref>paste</ref>,
+**! <ref>paste_alpha</ref>,
+**! <ref>paste_alpha_color</ref>,
+**! <ref>paste_mask</ref>
+**!
+**! getting subimages, scaling, rotating: <ref>autocrop</ref>,
+**! <ref>ccw</ref>,
+**! <ref>cw</ref>,
+**! <ref>clone</ref>,
+**! <ref>copy</ref>,
+**! <ref>dct</ref>,
+**! <ref>mirrorx</ref>,
+**! <ref>rotate</ref>,
+**! <ref>rotate_expand</ref>,
+**! <ref>scale</ref>,
+**! <ref>skewx</ref>,
+**! <ref>skewx_expand</ref>,
+**! <ref>skewy</ref>,
+**! <ref>skewy_expand</ref>
+**!
+**! calculation by pixels: <ref>apply_matrix</ref>,
+**! <ref>change_color</ref>,
+**! <ref>color</ref>,
+**! <ref>distancesq</ref>,
+**! <ref>grey</ref>,
+**! <ref>invert</ref>,
+**! <ref>map_closest</ref>,
+**! <ref>map_fast</ref>,
+**! <ref>modify_by_intensity</ref>,
+**! <ref>select_from</ref>
+**!
+**! converting to other datatypes: <ref>cast</ref>,
+**! <ref>fromgif</ref>,
+**! <ref>frompnm</ref>/<ref>fromppm</ref>,
+**! <ref>gif_add</ref>,
+**! <ref>gif_add_fs</ref>,
+**! <ref>gif_add_fs_nomap</ref>,
+**! <ref>gif_add_nomap</ref>,
+**! <ref>gif_begin</ref>,
+**! <ref>gif_end</ref>,
+**! <ref>gif_netscape_loop</ref>,
+**! <ref>to8bit</ref>,
+**! <ref>to8bit_closest</ref>,
+**! <ref>to8bit_fs</ref>,
+**! <ref>to8bit_rgbcube</ref>,
+**! <ref>to8bit_rgbcube_rdither</ref>,
+**! <ref>tobitmap</ref>,
+**! <ref>togif</ref>,
+**! <ref>togif_fs</ref>,
+**! <ref>toppm</ref>,
+**! <ref>tozbgr</ref>
+**!
+**! see also: Image, Image.font
#include "global.h"
@@ -12,7 +96,7 @@
#include "stralloc.h"
#include "global.h"
-RCSID("$Id: image.c,v 1.23 1997/04/18 06:47:26 mirar Exp $");
+RCSID("$Id: image.c,v 1.24 1997/04/19 12:33:57 mirar Exp $");
#include "types.h"
#include "pike_macros.h"
#include "object.h"
diff --git a/src/modules/Image/mkdoc.pike b/src/modules/Image/mkdoc.pike
index 89049791359e9bd4f373910590ab0c93a4256562..8aa1746a54330228d811ab934ddaab22205fd0da 100644
--- a/src/modules/Image/mkdoc.pike
+++ b/src/modules/Image/mkdoc.pike
@@ -56,31 +56,31 @@ mapping lower_nowM()
mapping keywords=
(["module":lambda(string arg,int line)
- { nowM=moduleM=focM(parse,stripws(arg),line); classM=methodM=0;
+ { descM=nowM=moduleM=focM(parse,stripws(arg),line); classM=methodM=0;
if (!nowM->classes) nowM->classes=([]); },
"class":lambda(string arg,int line)
{ if (!moduleM) return complain("class w/o module");
- nowM=classM=focM(moduleM->classes,stripws(arg),line);
+ descM=nowM=classM=focM(moduleM->classes,stripws(arg),line);
methodM=0; },
"method":lambda(string arg,int line)
{ if (!classM) return complain("method w/o class");
- if (!nowM || methodM!=nowM || methodM->desc || methodM->args)
+ if (!nowM || methodM!=nowM || methodM->desc || methodM->args || descM==methodM)
{ if (!classM->methods) classM->methods=({});
classM->methods+=({methodM=nowM=(["decl":({}),"_line":line])}); }
- methodM->decl+=({stripws(arg)}); },
+ methodM->decl+=({stripws(arg)}); descM=0; },
"arg":lambda(string arg,int line)
{
if (!methodM) return complain("arg w/o method");
if (nowM!=argM || !argM)
{ if (!methodM->args) methodM->args=({});
methodM->args+=({argM=nowM=(["args":({}),"_line":line])}); }
- argM->args+=({arg});
+ argM->args+=({arg}); descM=argM;
},
"note":lambda(string arg,int line)
{
if (!lower_nowM())
return complain("note w/o method, class or module");
- nowM=nowM->note||(nowM->note=(["_line":line]));
+ descM=nowM->note||(nowM->note=(["_line":line]));
},
"see":lambda(string arg,int line)
{
@@ -94,8 +94,8 @@ mapping keywords=
{
if (!methodM)
return complain("returns w/o method");
- nowM=0;
methodM->returns=stripws(arg);
+ descM=0; nowM=0;
}
]);
@@ -117,9 +117,32 @@ string addprefix(string suffix,string prefix)
return prefix+suffix;
}
+#define urlify(S) (replace((S),({"%","&","'","\"","`"}), \
+ ({"%25","%26","%27","%22","%60"})))
+#define htmlify(S) (replace((S),({"&","\240"}),({"&"," "})))
+
string make_nice_reference(string refto,string my_prefix)
{
- return "<tt><a href=#>"+refto+"</a></tt>";
+ string my_module,my_class,link,s,t;
+
+ if (sscanf(my_prefix,"%s.%s",my_module,my_class)==1)
+ my_class=0;
+
+ switch ((search(refto,"::")!=-1)+(search(refto,".")!=-1)*2)
+ {
+ case 0: if (refto!=my_module) link=my_prefix+"::"+refto;
+ else link=refto;
+ break;
+ case 1: link=my_module+"."+refto; break;
+ case 2:
+ case 3: link=refto; break;
+ }
+
+ if (search(link,"::")!=-1)
+ link=replace(link,"::",".html#");
+ else
+ link+=".html";
+ return "<tt><a href="+urlify(link)+">"+refto+"</a></tt>";
}
object(File) make_file(string filename)
@@ -151,7 +174,7 @@ string fixdesc(string s,string prefix)
t=v;
}
s+=t;
- return replace(s,"\n\n","\n\n<p>");
+ return htmlify(replace(s,"\n\n","\n\n<p>"));
}
string standard_doc(mapping info,string myprefix)
@@ -159,11 +182,12 @@ string standard_doc(mapping info,string myprefix)
string res="";
if (info->desc && stripws(info->desc)!="")
- res+="\n\n<blockquote>\n"+info->desc+"\n</blockquote>\n";
+ res+="\n\n<blockquote>\n"+fixdesc(info->desc,myprefix)+
+ "\n</blockquote>\n";
if (info->note)
res+="\n\n<h4>NOTE</h4>\n<blockquote>\n"+
- fixdesc(info->desc,myprefix)+"\n</blockquote>\n";
+ fixdesc(info->note->desc,myprefix)+"\n</blockquote>\n";
if (info["see also"])
{
@@ -188,10 +212,10 @@ void make_an_index(string title,
standard_doc(info,prefix));
if (sizeof(refs))
{
- f->write("<h3>More documentation:</h3>\n <i><tt>" +
+ f->write("<h3>More documentation:</h3>\n <i>" +
map(map(refs,addprefix,prefix),
make_nice_reference,prefix)*"</tt></i><br>\n <i><tt>" +
- "</tt></i>\n\n");
+ "</i>\n\n");
}
f->close();
}
@@ -216,22 +240,27 @@ string synopsis_to_html(string s)
return
type+" <b>"+name+"</b>("+
- replace(arg,({","," "}),({", "," "}));
+ replace(arg,({","," "}),({", ","\240"}));
}
void document_method(object(File) f,
mapping method,
string prefix)
{
+ string s;
+
stdout->write("documenting "+prefix+" methods "+
sort(indices(method->names))*", "+"...\n");
- f->write("\n<hr>\n"
- // anchors goes here
- "<h4>SYNOPSIS</h4>\n"
+ f->write("\n<hr>\n");
+
+ foreach (sort(indices(method->names)),s)
+ f->write("<a name="+urlify(s)+"> </a>\n");
+
+ f->write("<h4>SYNOPSIS</h4>\n"
"<blockquote>\n"
- "<tt>"+map(method->decl,synopsis_to_html)*
- "<br>\n"+
+ "<tt>"+htmlify(map(method->decl,synopsis_to_html)*
+ "<br>\n")+
"</tt>\n</blockquote>\n\n");
if (method->desc && stripws(method->desc)!="")
@@ -300,9 +329,9 @@ void document_class(string title,
method_names_arr=sort(indices(method_names));
- f->write("\n<hr>\n <i><tt>"+
- map(method_names_arr,make_nice_reference,prefix)*
- "</tt></i><br>\n <i><tt>"+"</tt></i><br>\n\n");
+/* f->write("\n<hr>\n <i><tt>"+*/
+/* map(method_names_arr,make_nice_reference,prefix)**/
+/* "</tt></i><br>\n <i><tt>"+"</tt></i><br>\n\n");*/
// alphabetically
foreach (method_names_arr,method_name)
@@ -377,16 +406,16 @@ int main()
}
else
{
- if (!nowM && !(nowM=descM) )
+ if (!descM) descM=methodM;
+ if (!descM)
{
stderr->write("Error on line "+line+": illegal description position\n");
return 1;
}
- if (!nowM->desc) nowM->desc="";
- else nowM->desc+="\n";
+ if (!descM->desc) descM->desc="";
+ else descM->desc+="\n";
s=getridoftabs(s);
- nowM->desc+=s[search(s,"**!")+3..];
- descM=nowM; nowM=0;
+ descM->desc+=s[search(s,"**!")+3..];
}
}
}