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