]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/img.mdwn
update
[ikiwiki.git] / doc / plugins / img.mdwn
1 [[template id=plugin name=img included=1 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 `alt` parameter is optional. The `size` parameter is also optional,
20 defaulting to full size.
21
22 Or set default values that will be applied to all later images on the page,
23 unless overridden. Useful when including many images on a page.
24
25         \[[img defaults size=200x200 alt="wedding photo"]]
26         \[[img photo1.jpg]]
27         \[[img photo2.jpg]]
28         \[[img photo3.jpg size=200x600]]