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 06c8429c8fff06e6f2b94ef1a9e7f93d655acbfb..898609a29e6edb692fafdb866fb2deae93dc35b4 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -1,5 +1,5 @@
-[[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
 images by making a [[ikiwiki/WikiLink]] that points to the image, using
 
 This is an image handling plugin. While ikiwiki supports inlining full-size
 images by making a [[ikiwiki/WikiLink]] that points to the image, using


@@ -14,7 +14,7 @@ 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 image file will be searched for using the same rules as used to find
 the file pointed to by a [[ikiwiki/WikiLink]].
 
 The image file will be searched for using the same rules as used to find
 the file pointed to by a [[ikiwiki/WikiLink]].


@@ -23,8 +23,9 @@ 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.
 
 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`, `class` and `id` parameters. These are passed through
-unchanged to the html img tag.
+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.

 
 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
 
 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


@@ -34,7 +35,7 @@ to another page instead, or "link=no" to disable the link, or
 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.
 
 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 defaults size=200x200 alt="wedding photo"]]
-       \[[img photo1.jpg]]
-       \[[img photo2.jpg]]
-       \[[img photo3.jpg size=200x600]]
+       \[[!img defaults size=200x200 alt="wedding photo"]]
+       \[[!img photo1.jpg]]
+       \[[!img photo2.jpg]]
+       \[[!img photo3.jpg size=200x600]]