add underlay files for listdirectives

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

diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index 3941ca2043c33a7538afcc6be7e66a8dd6611293..6da80b7e79781d2636149a586c827a0b4ff190d9 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -14,14 +14,16 @@ Note that this is a stripped down version of Christian Mock's
 
 ## 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 `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.
+making the image smaller than the specified size. You can also specify only
+the width or the height, and the other value will be calculated based on
+it: "200x", "x200".
 
 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`
@@ -35,7 +37,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.
 
-       \[[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]]