aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/meta.mdwn15
-rw-r--r--doc/plugins/write.mdwn4
2 files changed, 18 insertions, 1 deletions
diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index ec4348e41..0bcd11b67 100644
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -69,6 +69,21 @@ Supported fields:
\\[[meta openid="http://joeyh.myopenid.com/"
server="http://www.myopenid.com/server"]]
+* link
+
+ Specifies a link to another page. This can be used as a way to make the
+ wiki treat one page as linking to another without displaying a user-visible
+ [[ikiwiki/WikiLink]]:
+
+ \[[meta link=otherpage]]
+
+ It can also be used to insert a html <link> tag. For example:
+
+ \[[meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
+
+ However, this latter syntax won't be allowed if the [[htmlscrubber]] is
+ enabled, since it can be used to insert unsafe content.
+
* redir
Causes the page to redirect to another page in the wiki.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 34caf83f6..0da425402 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -123,7 +123,9 @@ An optional "scan" parameter, if set to a true value, makes the hook be
called during the preliminary scan that ikiwiki makes of updated pages,
before begining to render pages. This parameter should be set to true if
the hook modifies data in `%links`. Note that doing so will make the hook
-be run twice per page build, so avoid doing it for expensive hooks.
+be run twice per page build, so avoid doing it for expensive hooks. (As an
+optimisation, if your preprocessor hook is called in a void contets, you
+can assume it's being run in scan mode.)
Note that if the [[htmlscrubber]] is enabled, html in
[[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what