]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/meta.mdwn
* Change htmlize, format, and sanitize hooks to use named parameters.
[ikiwiki.git] / doc / plugins / meta.mdwn
index 998dd5d869451ce2385ccb49ebed42b942b1a3fd..f30efb873c47af286497746b4c2072a4f82ca188 100644 (file)
@@ -1,10 +1,11 @@
+[[template id=plugin name=meta included=1 author="[[Joey]]"]]
+[[tag type/meta]]
+
 This plugin allows inserting arbitrary metadata into the source of a page.
-This plugin is not enabled by default. If it is enabled, the title of this
-page will say it is. [[meta title="meta plugin (enabled)"]]
 Enter the metadata as follows:
 
-       \\[[meta field="value"]]
-       \\[[meta field="value" param="value" param="value"]]
+       \[[meta field="value"]]
+       \[[meta field="value" param="value" param="value"]]
 
 The first form sets a given field to a given value, while the second form
 also specifies some additional sub-parameters.
@@ -19,17 +20,21 @@ You can use any field names you like, but here are some predefined ones:
   can be useful when using links to categorise pages. A html link tag
   would look like this:
 
-       \\[[meta link="foo.css" rel="stylesheet" type="text/css"]]
+       \[[meta link="foo.css" rel="stylesheet" type="text/css"]]
 
   A non-user-visible [[WikiLink]] would instead look like this:
 
-       \\[[meta link=otherpage]]
+       \[[meta link=otherpage]]
 
 * title
 
   Overrides the title of the page, which is generally the same as the
   page name.
 
+  Note that if the title is overrideen, 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".
@@ -38,6 +43,17 @@ You can use any field names you like, but here are some predefined ones:
 
   Specifies the author of a page.
 
+* permalink
+
+  Specifies a permanent link to the page, if different than the page
+  generated by ikiwiki.
+
 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.
+
+The field value is treated as HTML entity-escaped text, so you can include
+a quote in the text by writing `"` and so on.
+
+If this plugin is enabled, the title of this page will say that it is.
+[[meta title="meta plugin (enabled)"]]