]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/img.mdwn
web commit by JoshTriplett: Link URL more simply.
[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 `alt` parameter is optional. The `size` parameter is also optional,
20 defaulting to full size. Note that the original image's aspect ratio is
21 always preserved, even if this means making the image smaller than the
22 specified size.
23
24 You can also set default values that will be applied to all later images on
25 the page, unless overridden. Useful when including many images on a page.
26
27         \[[img defaults size=200x200 alt="wedding photo"]]
28         \[[img photo1.jpg]]
29         \[[img photo2.jpg]]
30         \[[img photo3.jpg size=200x600]]
31
32 You can also reference an image in <ikiroot>/images like this:
33
34         \[[img images/photo3.jpg size=200x600]]