web commit by http://ethan.betacantrips.com/: moving comment over from [[patchqueue...

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

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 4df7f96f88815847be5c136b1a69128ec1827f10..5c3098e5632ec432f88dcc5fc2981da2b39be3dd 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -1,3 +1,6 @@
+[[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:
 


@@ -28,6 +31,10 @@ You can use any field names you like, but here are some predefined ones:
   Overrides the title of the page, which is generally the same as the
   page name.
 
   Overrides the title of the page, which is generally the same as the
   page name.
 

+  Note that if the title is overridden, a "title_overridden" variable will
+  be set to a true value in the template; this can be used to format things
+  differently in this case.
+

 * license
 
   Specifies a copyright license for the page, for example, "GPL".
 * license
 
   Specifies a copyright license for the page, for example, "GPL".


@@ -36,12 +43,19 @@ You can use any field names you like, but here are some predefined ones:
 
   Specifies the author of a page.
 
 
   Specifies the author of a page.
 

+* permalink
+
+  Specifies a permanent link to the page, if different than the page
+  generated by ikiwiki.
+
+* date
+
+  Specifies the creation date of the page. The date can be entered in
+  nearly any format, since it's parsed by [[cpan TimeDate]].
+

 If the field is not treated specially (as the link and title fields are),
 the metadata will be written to the generated html page as a <meta>
 header.
 
 If the field is not treated specially (as the link and title fields are),
 the metadata will be written to the generated html page as a <meta>
 header.
 

-This plugin is included in ikiwiki, but it is not enabled by default. If
-it is enabled, the title of this page will say it is.
-[[meta title="meta plugin (enabled)"]]
-
-[[tag plugins/type/meta]]
+The field value is treated as HTML entity-escaped text, so you can include
+a quote in the text by writing `"` and so on.