X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/e54d901565da5349b8f21e3e326d0f2d5d601ed9..5d108350bd4addc18c49c572f0d75b1b1db75457:/doc/plugins/img.mdwn diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn index 4a92cefc4..5d93e90c5 100644 --- a/doc/plugins/img.mdwn +++ b/doc/plugins/img.mdwn @@ -16,13 +16,24 @@ Note that this is a stripped down version of Christian Mock's \[[img image1.jpg size="200x200" alt="clouds"]] -Or set default values that will be applied to all later images on the page, -unless overridden. Useful when including many images on a page. +The image file will be searched for using the same rules as used to find +the file pointed to by a [[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 pass `alt`, `class` and `id` parameters. These are passed through +unchanged to the html img tag. + +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. + +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]] - -The `alt` parameter is optional. The `size` parameter is also optional, -defaulting to full size.