summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2017-09-21 12:27:50 +0200
committerJonas Smedegaard <dr@jones.dk>2017-09-21 12:27:50 +0200
commitc1a7d44351e37d4d101b1d3ec8f4f2efbf495678 (patch)
tree959bb8efab8505f2618b70fc5d7e38362a960772
parent8d8422b833aa9f06f3e783d3c7edfc9c20020ab9 (diff)
Sync with ikiwiki 3.20160506.
-rw-r--r--ikiwiki/directive/format.mdwn8
-rw-r--r--ikiwiki/directive/img.mdwn35
2 files changed, 38 insertions, 5 deletions
diff --git a/ikiwiki/directive/format.mdwn b/ikiwiki/directive/format.mdwn
index 04ed139..ae976fa 100644
--- a/ikiwiki/directive/format.mdwn
+++ b/ikiwiki/directive/format.mdwn
@@ -26,4 +26,12 @@ supported. For example:
print "hello, world\n";
"""]]
+`format` can also be used to format entire source files and display them on a page. Simply put an [[inline]] directive with the `raw` attribute set inside a `format`. This can be useful if you want to both serve the file raw, as well as show it syntax highlighted on a page. An example:
+
+ \[[!format python """
+ [[!inline pages="program.py" raw="yes"]]
+ """]]
+
+ \[[View raw file|program.py]]
+
[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/img.mdwn b/ikiwiki/directive/img.mdwn
index 08d1589..a940a44 100644
--- a/ikiwiki/directive/img.mdwn
+++ b/ikiwiki/directive/img.mdwn
@@ -12,11 +12,13 @@ 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 `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".
+
+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.)
You can also pass `alt`, `title`, `class`, `align`, `id`, `hspace`, and
`vspace` parameters.
@@ -39,4 +41,27 @@ the page, unless overridden. Useful when including many images on a page.
\[[!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"]]