web commit by http://per.bothner.com/: Alternate simple patch to view "A/B/C/index...

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

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 17a54c8d60a4a5c219892319300fb5db713c2839..d87bc05889aa02c230da15bf9f88450eeedccc68 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -1,8 +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.
 Enter the metadata as follows:
 
 This plugin allows inserting arbitrary metadata into the source of a page.
 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.
 
 The first form sets a given field to a given value, while the second form
 also specifies some additional sub-parameters.


@@ -17,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:
 
   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:
 
 
   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.
 
 
 * title
 
   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,10 +43,17 @@ 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.
+

 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.
+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)"]]
 [[meta title="meta plugin (enabled)"]]