X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/c522fffe09eea30a97213af1ecddfe6833d131e7..5afeca81546796673531d6e25fa1c84ab6da9733:/doc/plugins/meta.mdwn diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index fa37a8246..599d9cbd8 100644 --- 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: @@ -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 @@ -50,7 +55,7 @@ Supported fields: * 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 @@ -123,18 +128,17 @@ Supported fields: contents. In particular, it does not check the values against the set of valid values but serves whatever you pass it. -* uuid - - Specifies a globally unique ID for a page. This ID will be used, - rather than the page url, in RSS and Atom feeds. +* guid - The uuid can either be a literal 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 IDs for + This is mostly useful when a page has moved, to keep the guids for 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