web commit by JoshTriplett: Add another example, and add a description to each test.

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

diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index 78a5b17e6a0361c6a14d38e63faa6c963f984201..bbeb2a9f3fc4bb7f0e39fc14f86380d015c1d4e8 100644 (file)
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=img included=1 author="Christian Mock" ]]
+[[template id=plugin name=img author="Christian Mock"]]
 [[tag type/chrome]]
 
 This is an image handling plugin. While ikiwiki supports inlining full-size
@@ -17,12 +17,18 @@ Note that this is a stripped down version of Christian Mock's
        \[[img image1.jpg size="200x200" alt="clouds"]]
 
 The `alt` parameter is optional. The `size` parameter is also optional,
-defaulting to full size.
+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.
 
-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.
+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]]
+
+You can also reference an image in /images like this:
+
+       \[[img /images/photo3.jpg size=200x600]]