X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/1ac0fd03bb9e840b03aabe516557c24f43a9c450..8e05c93b4c1e39026ecbd9671d9c6e21332663a7:/doc/plugins/meta.mdwn diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index 479d62c43..0a934fc5c 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 @@ -64,10 +64,30 @@ Supported fields: * openid Adds html <link> tags to perform OpenID delegation to an external - OpenID server. This lets you use an ikiwiki page as your OpenID. Example: + OpenID server (for `openid` and `openid2`). An optional `xrds-location` + parameter lets you specify the location of any [eXtensible Resource + DescriptorS](http://www.windley.com/archives/2007/05/using_xrds.shtml). - \\[[meta openid="http://joeyh.myopenid.com/" - server="http://www.myopenid.com/server"]] + This lets you use an ikiwiki page as your OpenID. Example: + + \\[[meta openid="http://joeyh.myopenid.com/" + server="http://www.myopenid.com/server" + xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]] + +* 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 @@ -88,6 +108,21 @@ Supported fields: 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