Exclude working directory from library path (CVE-2016-1238)

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

diff --git a/doc/ikiwiki/directive/img.mdwn b/doc/ikiwiki/directive/img.mdwn
index ab3c07bfd3fbc78df6b78c6181f94a30ece012ee..a940a44b6567ef72c9f8b23a8900a1545be508d0 100644 (file)
--- a/doc/ikiwiki/directive/img.mdwn
+++ b/doc/ikiwiki/directive/img.mdwn
@@ -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


@@ -12,21 +12,27 @@ providing a link to a full-size version.
 The image file will be searched for using the same rules as used to find
 the file pointed to by a [[ikiwiki/WikiLink]].
 
 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"
+The `size` parameter is optional, defaulting to full size.
+You can 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.
+If you specify both the width and height, the original image's aspect
+ratio will be preserved, even if this means making the image smaller
+than the specified size. (However, this is not done for svg images.)

 
 

-The `link` parameter is used to control whether the scaled down image links
+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 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.
 


@@ -35,4 +41,27 @@ the page, unless overridden. Useful when including many images on a page.
        \[[!img photo2.jpg]]
        \[[!img photo3.jpg size=200x600]]
 
        \[[!img photo2.jpg]]
        \[[!img photo3.jpg size=200x600]]
 

+## format support
+
+By default, the `img` directive only supports a few common web formats:
+
+* PNG (`.png`)
+* JPEG (`.jpg` or `.jpeg`)
+* GIF (`.gif`)
+* SVG (`.svg`)
+
+These additional formats can be enabled with the `img_allowed_formats`
+[[!iki setup]] option, but are disabled by default for better
+[[!iki security]]:
+
+* PDF (`.pdf`)
+* `everything` (accepts any file supported by ImageMagick: make sure
+  that only completely trusted users can
+  [[upload attachments|ikiwiki/pagespec/attachment]])
+
+For example, a wiki where only `admin()` users can upload attachments might
+use:
+
+    img_allowed_formats: [png, jpeg, gif, svg, pdf]
+

 [[!meta robots="noindex, follow"]]
 [[!meta robots="noindex, follow"]]