418ef6d46b9cf5aedd3ccd517e4c80fa40cd3a21
[ikiwiki.git] / doc / plugins / img.mdwn
1 [[template id=plugin name=img author="Christian Mock"]]
2 [[tag type/chrome]]
3
4 This is an image handling plugin. While ikiwiki supports inlining full-size
5 images by making a [[WikiLink]] that points to the image, using this plugin
6 you can easily scale down an image for inclusion onto a page, providing a
7 link to a full-size version.
8
9 This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via
10 [PerlMagick](http://www.imagemagick.org/www/perl-magick.html).
11
12 Note that this is a stripped down version of Christian Mock's
13 [[original_img_plugin|contrib/img]].
14
15 ## usage
16
17         \[[img image1.jpg size="200x200" alt="clouds"]]
18
19 The image file will be searched for using the same rules as used to find
20 the file pointed to by a [[WikiLink]].
21
22 The `size` parameter is optional, defaulting to full size. Note that the
23 original image's aspect ratio is always preserved, even if this means
24 making the image smaller than the specified size.
25
26 You can also pass `alt`, `class` and `id` parameters. These are passed through
27 unchanged to the html img tag.
28
29 You can also set default values that will be applied to all later images on
30 the page, unless overridden. Useful when including many images on a page.
31
32         \[[img defaults size=200x200 alt="wedding photo"]]
33         \[[img photo1.jpg]]
34         \[[img photo2.jpg]]
35         \[[img photo3.jpg size=200x600]]