]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/meta.mdwn
* Patch from Ethan to allow using meta tags to set creation dates of pages.
[ikiwiki.git] / doc / plugins / meta.mdwn
1 [[template id=plugin name=meta author="[[Joey]]"]]
2 [[tag type/meta]]
3
4 This plugin allows inserting arbitrary metadata into the source of a page.
5 Enter the metadata as follows:
6
7         \[[meta field="value"]]
8         \[[meta field="value" param="value" param="value"]]
9
10 The first form sets a given field to a given value, while the second form
11 also specifies some additional sub-parameters.
12
13 You can use any field names you like, but here are some predefined ones:
14
15 * link
16
17   Specifies a link to another page. This is used to generate a html
18   <link> tag, and also as a way to make the wiki treat one page as
19   linking to another without displaying a user-visible link. The latter 
20   can be useful when using links to categorise pages. A html link tag
21   would look like this:
22
23         \[[meta link="foo.css" rel="stylesheet" type="text/css"]]
24
25   A non-user-visible [[WikiLink]] would instead look like this:
26
27         \[[meta link=otherpage]]
28
29 * title
30
31   Overrides the title of the page, which is generally the same as the
32   page name.
33
34   Note that if the title is overridden, a "title_overridden" variable will
35   be set to a true value in the template; this can be used to format things
36   differently in this case.
37
38 * license
39
40   Specifies a copyright license for the page, for example, "GPL".
41
42 * author
43
44   Specifies the author of a page.
45
46 * permalink
47
48   Specifies a permanent link to the page, if different than the page
49   generated by ikiwiki.
50
51 * date
52
53   Specifies the creation date of the page. The date can be entered in
54   nearly any format, since it's parsed by [[cpan TimeDate]].
55
56 If the field is not treated specially (as the link and title fields are),
57 the metadata will be written to the generated html page as a <meta>
58 header.
59
60 The field value is treated as HTML entity-escaped text, so you can include
61 a quote in the text by writing `"` and so on.