Document the 'generated' keyword argument

[git.ikiwiki.info.git] / doc / plugins / img.mdwn

diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index b8b82a967edffbca2ee774f1976ac941bc002db8..898609a29e6edb692fafdb866fb2deae93dc35b4 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -1,10 +1,10 @@
-[[template id=plugin name=img author="Christian Mock"]]
-[[tag type/chrome]]
+[[!template id=plugin name=img author="Christian Mock"]]
+[[!tag type/chrome]]

 
 This is an image handling plugin. While ikiwiki supports inlining full-size
 
 This is an image handling plugin. While ikiwiki supports inlining full-size

-images by making a [[WikiLink]] that points to the image, using this plugin
-you can easily scale down an image for inclusion onto a page, providing a
-link to a full-size version.
+images by making a [[ikiwiki/WikiLink]] that points to the image, using
+this plugin you can easily scale down an image for inclusion onto a page,
+providing a link to a full-size version.

 
 This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via
 [PerlMagick](http://www.imagemagick.org/www/perl-magick.html).
 
 This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via
 [PerlMagick](http://www.imagemagick.org/www/perl-magick.html).


@@ -14,21 +14,28 @@ Note that this is a stripped down version of Christian Mock's
 
 ## usage
 
 
 ## usage
 

-       \[[img image1.jpg size="200x200" alt="clouds"]]
+       \[[!img image1.jpg size="200x200" alt="clouds"]]

 
 

-The `alt` parameter is optional. The `size` parameter is also optional,
-defaulting to full size. Note that the original image's aspect ratio is
-always preserved, even if this means making the image smaller than the
-specified size.
+The image file will be searched for using the same rules as used to find
+the file pointed to by a [[ikiwiki/WikiLink]].

 
 

-You can also set default values that will be applied to all later images on
-the page, unless overridden. Useful when including many images on a page.
+The `size` parameter is optional, defaulting to full size. Note that the
+original image's aspect ratio is always preserved, even if this means
+making the image smaller than the specified size.
+
+You can also pass `alt`, `title`, `class` and `id` parameters. These are
+passed through unchanged to the html img tag. If you include a `caption`
+parameter, the caption will be displayed centered beneath the image.

 
 

-       \[[img defaults size=200x200 alt="wedding photo"]]
-       \[[img photo1.jpg]]
-       \[[img photo2.jpg]]
-       \[[img photo3.jpg size=200x600]]
+The `link` parameter is used to control whether the scaled down image links
+to the full size version. By default it does; set "link=somepage" to link
+to another page instead, or "link=no" to disable the link, or
+"link=http://url" to link to a given url.

 
 

-You can also reference an image in <ikiroot>/images like this:
+You can also set default values that will be applied to all later images on
+the page, unless overridden. Useful when including many images on a page.

 
 

-       \[[img images/photo3.jpg size=200x600]]
+       \[[!img defaults size=200x200 alt="wedding photo"]]
+       \[[!img photo1.jpg]]
+       \[[!img photo2.jpg]]
+       \[[!img photo3.jpg size=200x600]]