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 de04dcdd533a6a38a4021ef6721d403c3d8f5421..d87bc05889aa02c230da15bf9f88450eeedccc68 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -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:
 
 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".


@@ -38,7 +45,7 @@ You can use any field names you like, but here are some predefined ones:
 
 * permalink
 
 
 * permalink
 

-  Specifies a perminent link to the page, if different than the page
+  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),
   generated by ikiwiki.
 
 If the field is not treated specially (as the link and title fields are),


@@ -48,8 +55,5 @@ 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.
 
 The field value is treated as HTML entity-escaped text, so you can include
 a quote in the text by writing `"` and so on.
 

-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.
+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)"]]

-
-[[tag type/meta]]