(no commit message)

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

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 12240422dbabfa40339d2dabfef609f2ce7455c3..599d9cbd84e2c718f877701861ad92df15f8954e 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -1,5 +1,5 @@
-[[template id=plugin name=meta author="[[Joey]]"]]
-[[tag type/meta]]
+[[!template id=plugin name=meta author="[[Joey]]"]]
+[[!tag type/meta]]

 
 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:


@@ -42,6 +42,11 @@ Supported fields:
 
   Specifies an url for the author of a page.
 
 
   Specifies an url for the author of a page.
 

+* 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.
+

 * permalink
 
   Specifies a permanent link to the page, if different than the page
 * permalink
 
   Specifies a permanent link to the page, if different than the page


@@ -50,7 +55,7 @@ Supported fields:
 * date
 
   Specifies the creation date of the page. The date can be entered in
 * date
 
   Specifies the creation date of the page. The date can be entered in

-  nearly any format, since it's parsed by [[cpan TimeDate]].
+  nearly any format, since it's parsed by [[!cpan TimeDate]].

 
 * stylesheet
 
 
 * stylesheet
 


@@ -125,16 +130,15 @@ Supported fields:
 
 * guid
 
 
 * 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.
+  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's feed has moved, to keep the guids for
+  This is mostly useful when a page has moved, to keep the guids for

   pages unchanged and
   pages unchanged and

-  [[avoid_flooding_aggregators|howto_avoid_flooding_aggregators]].
+  [[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
 
 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