diff options
Diffstat (limited to 'underlays/basewiki/directive/img.mdwn')
-rw-r--r-- | underlays/basewiki/directive/img.mdwn | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/img.mdwn b/underlays/basewiki/directive/img.mdwn new file mode 100644 index 000000000..d8c9f359f --- /dev/null +++ b/underlays/basewiki/directive/img.mdwn @@ -0,0 +1,36 @@ +The `img` directive is supplied by the [[!iki plugins/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 plugin you can easily scale down an image for inclusion onto a page, +providing a link to a full-size version. + +## 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]] |