]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/meta.mdwn
* meta: Support license and copyright information. The information will
[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 The field values are treated as HTML entity-escaped text, so you can include
14 a quote in the text by writing `"` and so on.
15
16 You can use any field names you like, but here are some predefined ones:
17
18 * link
19
20   Specifies a link to another page. This can be used as a way to make the
21   wiki treat one page as linking to another without displaying a user-visible
22   [[WikiLink]]:
23
24         \[[meta link=otherpage]]
25
26   It can also be used to insert a html <link> tag. For example:
27
28         \[[meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
29
30   However, this latter syntax won't be allowed if the [[htmlscrubber]] is
31   enabled, since it can be used to insert unsafe content.
32
33 * title
34
35   Overrides the title of the page, which is generally the same as the
36   page name.
37
38   Note that if the title is overridden, a "title_overridden" variable will
39   be set to a true value in the template; this can be used to format things
40   differently in this case.
41
42 * license
43
44   Specifies a license for the page, for example, "GPL". Can contain
45   WikiLinks.
46
47 * copyright
48
49   Specifies the copyright of the page, for example, "Copyright 2007 by
50   Joey Hess". Can contain WikiLinks.
51
52 * author
53
54   Specifies the author of a page.
55
56 * authorurl
57
58   Specifies an url for the author of a page.
59
60 * permalink
61
62   Specifies a permanent link to the page, if different than the page
63   generated by ikiwiki.
64
65 * date
66
67   Specifies the creation date of the page. The date can be entered in
68   nearly any format, since it's parsed by [[cpan TimeDate]].
69
70 * stylesheet
71
72   Adds a stylesheet to a page. The stylesheet is treated as a wiki link to
73   a `.css` file in the wiki, so it cannot be used to add links to external
74   stylesheets. Example:
75
76         \[[meta stylesheet=somestyle rel="alternate stylesheet"
77         title="somestyle"]]
78
79 * openid
80
81   Adds html <link> tags to perform OpenID delegation to an external
82   OpenID server. This lets you use an ikiwiki page as your OpenID. Example:
83
84         \\[[meta openid="http://joeyh.myopenid.com/"
85         server="http://www.myopenid.com/server"]]
86
87 If the field is not one of the above predefined fields, the metadata will be
88 written to the generated html page as a <meta> header. However, this
89 won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to
90 insert unsafe content.