rename uuid to guid

[git.ikiwiki.info.git] / doc / plugins / meta.mdwn

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 0a934fc5cb73438f43e7d1c147f527db95007b0b..12240422dbabfa40339d2dabfef609f2ce7455c3 100644 (file)
--- 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:
 
 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.
 
 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:
 
   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
        title="somestyle"]]
 
 * openid


@@ -70,7 +70,7 @@ Supported fields:
 
   This lets you use an ikiwiki page as your OpenID. Example:
 
 
   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""]]
 
        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]]:
 
   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:
 
 
   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.
 
   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.
 
 
   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:
 
 
   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.
 
   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:
 
 
   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
 
   Valid values for the attribute are: "index", "noindex", "follow", and
   "nofollow". Multiple comma-separated values are allowed, but obviously only


@@ -123,6 +123,19 @@ Supported fields:
   contents. In particular, it does not check the values against the set of
   valid values but serves whatever you pass it.
 
   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 will be used,
+  rather than the page url, to identify the page in RSS and Atom feeds.
+
+  The guid can either be a uuid (ie,
+  "ec248d04-f347-4eb8-92b6-671b15d36980"), or it can be an alternative URL
+  for the page.
+
+  This is mostly useful when a page's feed has moved, to keep the guids for
+  pages unchanged and
+  [[avoid_flooding_aggregators|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
 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