diff options
| author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
| commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
| tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/img.mdwn | |
| parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) | |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/img.mdwn')
| -rw-r--r-- | doc/plugins/img.mdwn | 33 |
1 files changed, 2 insertions, 31 deletions
diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn index 6da80b7e7..04077d065 100644 --- a/doc/plugins/img.mdwn +++ b/doc/plugins/img.mdwn @@ -1,7 +1,8 @@ [[!template id=plugin name=img author="Christian Mock"]] [[!tag type/chrome]] -This is an image handling plugin. While ikiwiki supports inlining full-size +This plugin implements the [[ikiwiki/directive/img]] [[ikiwiki/directive]]. +This is an image handling directive. While ikiwiki supports inlining full-size 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. @@ -11,33 +12,3 @@ This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via Note that this is a stripped down version of Christian Mock's [[original_img_plugin|contrib/img]]. - -## usage - - \[[!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 [[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 specify only -the width or the height, and the other value will be calculated based on -it: "200x", "x200". - -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=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. - - \[[!img defaults size=200x200 alt="wedding photo"]] - \[[!img photo1.jpg]] - \[[!img photo2.jpg]] - \[[!img photo3.jpg size=200x600]] |