X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b1b7a2100f6b32ef6bf75e9992e10ed7d28f8525..465f101d905ef88d0b03aab018f97a39c5532b27:/doc/ikiwiki/directive/img.mdwn diff --git a/doc/ikiwiki/directive/img.mdwn b/doc/ikiwiki/directive/img.mdwn index 66efd008e..fa3b40f50 100644 --- a/doc/ikiwiki/directive/img.mdwn +++ b/doc/ikiwiki/directive/img.mdwn @@ -12,21 +12,27 @@ providing a link to a full-size version. 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" +The `size` parameter is optional, defaulting to full size. +You can 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`, `align` and `id` parameters. +If you specify both the width and height, the original image's aspect +ratio will be preserved, even if this means making the image smaller +than the specified size. (However, this is not done for svg images.) + +You can also pass `alt`, `title`, `class`, `align`, `id`, `hspace`, and +`vspace` 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 +The `link` parameter is used to control whether the scaled 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. +The `pagenumber` parameter selects which of multiple images should be rendered; +this is relevant mainly for GIF and PDF source images. + 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.