X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/96817b00326b983299ce701532643f763259af89..227107b21864dedb40995875c6a68c1a2a665f9a:/doc/plugins/meta.mdwn?ds=sidebyside diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index 0696dc08e..b503e4511 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -27,12 +27,12 @@ Supported fields: * license Specifies a license for the page, for example, "GPL". Can contain - WikiLinks. + WikiLinks and arbitrary markup. * copyright Specifies the copyright of the page, for example, "Copyright 2007 by - Joey Hess". Can contain WikiLinks. + Joey Hess". Can contain WikiLinks and arbitrary markup. * author @@ -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. @@ -85,6 +100,24 @@ Supported fields: However, this latter syntax won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to insert unsafe content. + For both cases, an anchor to jump to inside the destination page may also be + specified using the common `PAGE#ANCHOR` syntax. + +* robots + + Causes the robots meta tag to be written: + + \[[meta robots="index, nofollow"]] + + Valid values for the attribute are: "index", "noindex", "follow", and + "nofollow". Multiple comma-separated values are allowed, but obviously only + some combinations make sense. If there is no robots meta tag, "index, + follow" is used as the default. + + The plugin escapes the value, but otherwise does not care about its + contents. In particular, it does not check the values against the set of + valid values but serves whatever you pass it. + If the field is not one of the above predefined fields, the metadata will be written to the generated html page as a <meta> header. However, this won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to