X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/3bd439fa03c13f19e7305b82fff23779e303154d..28aba38ed97fc779ce1c4139549e05b8336beaef:/doc/plugins/img.mdwn?ds=sidebyside diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn index 63006443a..a4661f1a8 100644 --- a/doc/plugins/img.mdwn +++ b/doc/plugins/img.mdwn @@ -2,9 +2,9 @@ [[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). @@ -17,18 +17,20 @@ Note that this is a stripped down version of Christian Mock's \[[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 [[WikiLink]]. +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. -You can also pass `alt`, `class` and `id` parameters. These are passed through -unchanged to the html img tag. +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` +parameter, the caption will be displayed centered beneath the image. The `link` parameter is used to control whether the scaled down image links -to the full size version. By default it does; set "link=no" to disable -this. +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.