web commit by http://openid.eharning.us/

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

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 78a8c9339bdb225c65d1977d47b7d0e1063b7121..479d62c434034262e000a01f843079b49a2d89e8 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -13,22 +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
-  [[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.
+Supported fields:
 
 * title
 
@@ -41,7 +26,13 @@ You can use any field names you like, but here are some predefined ones:
 
 * license
 
-  Specifies a copyright license for the page, for example, "GPL".
+  Specifies a license for the page, for example, "GPL". Can contain
+  WikiLinks.
+
+* copyright
+
+  Specifies the copyright of the page, for example, "Copyright 2007 by
+  Joey Hess". Can contain WikiLinks.
 
 * author
 
@@ -78,6 +69,25 @@ 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"]]
 
+* 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