]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/meta.mdwn
* Add typography (SmartyPants) plugin by Recai.
[ikiwiki.git] / doc / plugins / meta.mdwn
index 4df7f96f88815847be5c136b1a69128ec1827f10..f30efb873c47af286497746b4c2072a4f82ca188 100644 (file)
@@ -1,3 +1,6 @@
+[[template id=plugin name=meta included=1 author="[[Joey]]"]]
+[[tag type/meta]]
+
 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.
 
+  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".
@@ -36,12 +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.
 
-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)"]]
+The field value is treated as HTML entity-escaped text, so you can include
+a quote in the text by writing `"` and so on.
 
-[[tag plugins/type/meta]]
+If this plugin is enabled, the title of this page will say that it is.
+[[meta title="meta plugin (enabled)"]]