meta headers are not sanitised; prevent html leaking into them
[ikiwiki.git] / doc / plugins / meta.mdwn
1 This plugin allows inserting arbitrary metadata into the source of a page.
2 This plugin is not enabled by default. If it is enabled, the title of this
3 page will say it is. [[meta title="meta plugin (enabled)"]]
4 Enter the metadata as follows:
5
6         \\[[meta field="value"]]
7         \\[[meta field="value" param="value" param="value"]]
8
9 The first form sets a given field to a given value, while the second form
10 also specifies some additional sub-parameters.
11
12 You can use any field names you like, but here are some predefined ones:
13
14 * link
15
16   Specifies a link to another page. This is used to generate a html
17   <link> tag, and also as a way to make the wiki treat one page as
18   linking to another without displaying a user-visible link. The latter 
19   can be useful when using links to categorise pages. A html link tag
20   would look like this:
21
22         \\[[meta link="foo.css" rel="stylesheet" type="text/css"]]
23
24   A non-user-visible [[WikiLink]] would instead look like this:
25
26         \\[[meta link=otherpage]]
27
28 * title
29
30   Overrides the title of the page, which is generally the same as the
31   page name.
32
33 * license
34
35   Specifies a copyright license for the page, for example, "GPL".
36
37 * author
38
39   Specifies the author of a page.
40
41 If the field is not treated specially (as the link and title fields are),
42 the metadata will be written to the generated html page as a <meta>
43 header.