X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c471d5425faa1ce813a4ce8d564bf634346746a3..8d9ec24232ede981face0c3eafbce71b74c4725a:/doc/plugins/meta.mdwn?ds=sidebyside diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index 0a934fc5c..506ac84a8 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -4,8 +4,8 @@ This plugin allows inserting arbitrary metadata into the source of a page. Enter the metadata as follows: - \[[meta field="value"]] - \[[meta field="value" param="value" param="value"]] + \[[!meta field="value"]] + \[[!meta field="value" param="value" param="value"]] The first form sets a given field to a given value, while the second form also specifies some additional sub-parameters. @@ -58,7 +58,7 @@ Supported fields: a `.css` file in the wiki, so it cannot be used to add links to external stylesheets. Example: - \[[meta stylesheet=somestyle rel="alternate stylesheet" + \[[!meta stylesheet=somestyle rel="alternate stylesheet" title="somestyle"]] * openid @@ -70,7 +70,7 @@ Supported fields: This lets you use an ikiwiki page as your OpenID. Example: - \\[[meta openid="http://joeyh.myopenid.com/" + \\[[!meta openid="http://joeyh.myopenid.com/" server="http://www.myopenid.com/server" xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]] @@ -80,11 +80,11 @@ Supported fields: wiki treat one page as linking to another without displaying a user-visible [[ikiwiki/WikiLink]]: - \[[meta link=otherpage]] + \[[!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"]] + \[[!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. @@ -93,14 +93,14 @@ Supported fields: Causes the page to redirect to another page in the wiki. - \[[meta redir=otherpage]] + \[[!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/"]] + \[[!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. @@ -112,7 +112,7 @@ Supported fields: Causes the robots meta tag to be written: - \[[meta robots="index, nofollow"]] + \[[!meta robots="index, nofollow"]] Valid values for the attribute are: "index", "noindex", "follow", and "nofollow". Multiple comma-separated values are allowed, but obviously only @@ -123,6 +123,18 @@ Supported fields: contents. In particular, it does not check the values against the set of valid values but serves whatever you pass it. +* guid + + Specifies a globally unique ID for a page. This guid should be a URI + (in particular, it can be `urn:uuid:` followed by a UUID, as per + [[!rfc 4122]]), and it will be used to identify the page's entry in RSS + and Atom feeds. If not given, the default is to use the page's URL as its + guid. + + This is mostly useful when a page has moved, to keep the guids for + pages unchanged and + [[avoid_flooding_aggregators|tips/howto_avoid_flooding_aggregators]]. + 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