web commit by http://id.kurokatta.org/david: Copyedit.

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

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index cacb462c9564e8f2efdb55f270c3a191f27be4d1..f30efb873c47af286497746b4c2072a4f82ca188 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 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".
 * license
 
   Specifies a copyright license for the page, for example, "GPL".


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

-  Specifies the permalink to the page, for use in RSS feeds.
+  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>
 
 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>


@@ -47,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]]