]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/ikiwiki/directive/img.mdwn
(no commit message)
[git.ikiwiki.info.git] / doc / ikiwiki / directive / img.mdwn
index ab3c07bfd3fbc78df6b78c6181f94a30ece012ee..08d15898702ca800c825cc33cb610c34bec50f23 100644 (file)
@@ -1,4 +1,4 @@
-The `img` directive is supplied by the [[!iki plugins/img]] plugin.
+The `img` directive is supplied by the [[!iki plugins/img desc=img]] plugin.
 
 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 is an image handling directive.  While ikiwiki supports inlining full-size
 images by making a [[ikiwiki/WikiLink]] that points to the image, using
@@ -18,15 +18,19 @@ 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 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.
+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.
 
 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.
 
 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.