X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/fa90bdf4bf44d108bd8c3d53104b48aa20dc18eb..8b54578882e17fe8c059515902e9d19fd80c2896:/doc/plugins/meta.mdwn diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index f97e267ef..0bcd11b67 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -13,38 +13,7 @@ also specifies some additional sub-parameters. The field values are treated as HTML entity-escaped text, so you can include a quote in the text by writing `"` and so on. -You can use any field names you like, but here are some predefined ones: - -* 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. - - \[[meta redir=otherpage]] - - Optionally, a delay (in seconds) can be specified. The default is to - redirect without delay. - - It can also be used to redirect to an external url. For example: - - \[[meta redir="http://example.com/"]] - - However, this latter syntax won't be allowed if the [[htmlscrubber]] is - enabled, since it can be used to insert unsafe content. +Supported fields: * title @@ -58,12 +27,12 @@ You can use any field names you like, but here are some predefined ones: * 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 @@ -100,6 +69,40 @@ You can use any field names you like, but here are some predefined ones: \\[[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. + + \[[meta redir=otherpage]] + + Optionally, a delay (in seconds) can be specified. The default is to + redirect without delay. + + It can also be used to redirect to an external url. For example: + + \[[meta redir="http://example.com/"]] + + 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. + 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