]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/meta.mdwn
note copyright of po.pm
[ikiwiki.git] / doc / plugins / meta.mdwn
index 84d48d8ef8d346d91e855616531b06b72c065f51..afd55499303f42dd4284c457623bb543fd09003c 100644 (file)
@@ -1,59 +1,5 @@
-[[template id=plugin name=meta included=1 author="""[[Joey]]"""]]
-[[tag type/meta]]
+[[!template id=plugin name=meta author="[[Joey]]"]]
+[[!tag type/meta]]
 
-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"]]
-
-The first form sets a given field to a given value, while the second form
-also specifies some additional sub-parameters.
-
-You can use any field names you like, but here are some predefined ones:
-
-* link
-
-  Specifies a link to another page. This is used to generate a html
-  <link> tag, and also as a way to make the wiki treat one page as
-  linking to another without displaying a user-visible link. The latter 
-  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"]]
-
-  A non-user-visible [[WikiLink]] would instead look like this:
-
-       \[[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".
-
-* author
-
-  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)"]]
+This plugin provides the [[ikiwiki/directive/meta]] [[ikiwiki/directive]],
+which allows inserting various metadata into the source of a page.