web commit by LucaBrivio

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

diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index 78a5b17e6a0361c6a14d38e63faa6c963f984201..06c8429c8fff06e6f2b94ef1a9e7f93d655acbfb 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -1,10 +1,10 @@
-[[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
 [[tag type/chrome]]
 
 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).


@@ -16,11 +16,23 @@ Note that this is a stripped down version of Christian Mock's
 
        \[[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.
+The image file will be searched for using the same rules as used to find
+the file pointed to by a [[ikiwiki/WikiLink]].

 
 

-Or 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`, `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, or
+"link=http://url" to link to a given url.
+
+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 defaults size=200x200 alt="wedding photo"]]
        \[[img photo1.jpg]]