X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/da81fcd8eeb5591ee36b1e3145452e36a2be20ed..246e93a300f81d67f5e6339e77cd533b815da9e9:/doc/plugins/img.mdwn?ds=inline diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn index bbeb2a9f3..06c8429c8 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). @@ -16,10 +16,20 @@ 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 [[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. + +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. @@ -28,7 +38,3 @@ the page, unless overridden. Useful when including many images on a page. \[[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]]