Migrate doc/todo via prefix_directives

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

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index c3f971d06bd6a24144e16a27cfe1768d87b354a4..b1e0cb7579e56e702b985565e01331823249f22e 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -42,6 +42,11 @@ Supported fields:
 
   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
@@ -123,6 +128,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