web commit by http://ptecza.myopenid.com/: * Ping

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

diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index 324d46cc55d6f21cf09aeafa5fb6f166b1dfb114..5d93e90c50a011180cebde20d4abbe6e099aab6e 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=img included=1 author="Christian Mock" ]]
+[[template id=plugin name=img author="Christian Mock"]]
 [[tag type/chrome]]
 
 This is an image handling plugin. While ikiwiki supports inlining full-size
@@ -16,10 +16,19 @@ Note that this is a stripped down version of Christian Mock's
 
        \[[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 [[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.
+
+You can also pass `alt`, `class` and `id` parameters. These are passed through
+unchanged to the html img tag.
+
+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.
 
 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.