]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/ikiwiki/directive/meta.mdwn
I'm not redefining any subs after all, don't prevent those warnings.
[git.ikiwiki.info.git] / doc / ikiwiki / directive / meta.mdwn
index b01dbfe7605694159191ed08b61ee456f9c15a79..000f461c9751f9fba13f7eba71880568819c654c 100644 (file)
@@ -1,6 +1,6 @@
-The `meta` directive is supplied by the [[!iki plugins/meta]] plugin.
+The `meta` directive is supplied by the [[!iki plugins/meta desc=meta]] plugin.
 
-This plugin allows inserting arbitrary metadata into the source of a page.
+This directive allows inserting arbitrary metadata into the source of a page.
 Enter the metadata as follows:
 
        \[[!meta field="value"]]
@@ -44,7 +44,7 @@ Supported fields:
 * description
 
   Specifies a "description" of the page. You could use this to provide
-  a summary, for example, to be picked up by the [[map]] plugin.
+  a summary, for example, to be picked up by the [[map]] directive.
 
 * permalink
 
@@ -68,11 +68,16 @@ Supported fields:
 * openid
 
   Adds html <link> tags to perform OpenID delegation to an external
-  OpenID server (for `openid` and `openid2`). An optional `xrds-location`
+  OpenID server. This lets you use an ikiwiki page as your OpenID.
+
+  By default this will delegate for both `openid` and `openid2`. To only
+  delegate for one, add a parameter such as `delegate=openid`.
+
+  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).
 
-  This lets you use an ikiwiki page as your OpenID. Example:
+  Example:
 
        \\[[!meta openid="http://joeyh.myopenid.com/"
        server="http://www.myopenid.com/server"
@@ -91,7 +96,7 @@ Supported fields:
        \[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
 
   However, this latter syntax won't be allowed if the 
-  [[!iki plugins/htmlscrubber]] plugin is enabled, since it can be used to
+  [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, since it can be used to
   insert unsafe content.
 
 * redir
@@ -108,7 +113,7 @@ Supported fields:
        \[[!meta redir="http://example.com/"]]
 
   However, this latter syntax won't be allowed if the 
-  [[!iki plugins/htmlscrubber]] plugin is enabled, since it can be used to
+  [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin 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
@@ -125,9 +130,7 @@ Supported fields:
   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.
+  The value is escaped, but its contents are not otherwise checked.
 
 * guid
 
@@ -141,9 +144,18 @@ Supported fields:
   pages unchanged and avoid_flooding_aggregators
   (see [[!iki tips/howto_avoid_flooding_aggregators]]).
 
+* updated
+
+  Specifies a fake modification time for a page, to be output into RSS and
+  Atom feeds. This is useful to avoid flooding aggregators that sort by
+  modification time, like Planet: for instance, when editing an old blog post
+  to add tags, you could set `updated` to be one second later than the original
+  value. The date/time can be given in any format that
+  [[!cpan TimeDate]] can understand, just like the `date` field.
+
 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 [[!iki plugins/htmlscrubber]] plugin is enabled,
+won't be allowed if the [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled,
 since it can be used to insert unsafe content.
 
 [[!meta robots="noindex, follow"]]