X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f170a45108dd617a285849aa3b93cd7b55a45967..0daa7a122f5e5c51fbd091a1f0c7b720b59a6172:/doc/plugins/img.mdwn diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn index b8b82a967..a6cd90f28 100644 --- a/doc/plugins/img.mdwn +++ b/doc/plugins/img.mdwn @@ -1,34 +1,14 @@ -[[template id=plugin name=img 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). 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. 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 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]] - -You can also reference an image in /images like this: - - \[[img images/photo3.jpg size=200x600]]