web commit by JoshTriplett: Link URL more simply.

[ikiwiki.git] / doc / plugins / img.mdwn

diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index 4a92cefc40ce2f581cf35ae38b86142f5781d21a..b8b82a967edffbca2ee774f1976ac941bc002db8 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -16,13 +16,19 @@ 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 `alt` parameter is optional. The `size` parameter is also 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 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.
+You can also reference an image in <ikiroot>/images like this:
+
+       \[[img images/photo3.jpg size=200x600]]