]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/img.mdwn
updated branch; this is ready for review for inclusion in IkIWiki
[git.ikiwiki.info.git] / doc / plugins / img.mdwn
index 78a5b17e6a0361c6a14d38e63faa6c963f984201..9eadb650ace8a4b8503a37a618d32c9772199573 100644 (file)
@@ -1,28 +1,14 @@
-[[template id=plugin name=img included=1 author="Christian Mock" ]]
-[[tag type/chrome]]
+[[!template id=plugin name=img author="Christian Mock"]]
+[[!tag type/widget]]
 
-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.
+This plugin provides the [[ikiwiki/directive/img]] [[ikiwiki/directive]].
+While ikiwiki supports inlining full-size images by making a
+[[ikiwiki/WikiLink]] that points to the image, using this directive 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).
+[PerlMagick](http://www.imagemagick.org/script/perl-magick.php).
 
 Note that this is a stripped down version of Christian Mock's
 [[original_img_plugin|contrib/img]].
-
-## usage
-
-       \[[img image1.jpg size="200x200" alt="clouds"]]
-
-The `alt` parameter is optional. The `size` parameter is also optional,
-defaulting to full size.
-
-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.
-
-       \[[img defaults size=200x200 alt="wedding photo"]]
-       \[[img photo1.jpg]]
-       \[[img photo2.jpg]]
-       \[[img photo3.jpg size=200x600]]