8d2a5b1ad40129622f2d20724955c0bfdeeeb845
[ikiwiki.git] / doc / ikiwiki / directive / meta.mdwn
1 The `meta` directive is supplied by the [[!iki plugins/meta desc=meta]] plugin.
2
3 This directive allows inserting arbitrary metadata into the source of a page.
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 The field values are treated as HTML entity-escaped text, so you can include
13 a quote in the text by writing `"` and so on.
14
15 Supported fields:
16
17 * title
18
19   Overrides the title of the page, which is generally the same as the
20   page name.
21
22   Note that if the title is overridden, a "title_overridden" variable will
23   be set to a true value in the template; this can be used to format things
24   differently in this case.
25
26   An optional `sort` parameter will be used preferentially when
27   [[ikiwiki/pagespec/sorting]] by `meta_title`:
28
29         \[[!meta title="The Beatles" sort="Beatles, The"]]
30
31         \[[!meta title="David Bowie" sort="Bowie, David"]]
32
33 * license
34
35   Specifies a license for the page, for example, "GPL". Can contain
36   WikiLinks and arbitrary markup.
37
38 * copyright
39
40   Specifies the copyright of the page, for example, "Copyright 2007 by
41   Joey Hess". Can contain WikiLinks and arbitrary markup.
42
43 * author
44
45   Specifies the author of a page.
46
47 * authorurl
48
49   Specifies an url for the author of a page.
50
51 * description
52
53   Specifies a short description for the page. This will be put in
54   the html header, and can also be displayed by eg, the [[map]] directive.
55
56 * permalink
57
58   Specifies a permanent link to the page, if different than the page
59   generated by ikiwiki.
60
61 * date
62
63   Specifies the creation date of the page. The date can be entered in
64   nearly any format, since it's parsed by [[!cpan TimeDate]].
65
66 * stylesheet
67
68   Adds a stylesheet to a page. The stylesheet is treated as a wiki link to
69   a `.css` file in the wiki, so it cannot be used to add links to external
70   stylesheets. Example:
71
72         \[[!meta stylesheet=somestyle rel="alternate stylesheet"
73         title="somestyle"]]
74
75 * openid
76
77   Adds html <link> tags to perform OpenID delegation to an external
78   OpenID server. This lets you use an ikiwiki page as your OpenID.
79
80   By default this will delegate for both `openid` and `openid2`. To only
81   delegate for one, add a parameter such as `delegate=openid`.
82
83   An optional `xrds-location`
84   parameter lets you specify the location of any [eXtensible Resource
85   DescriptorS](http://www.windley.com/archives/2007/05/using_xrds.shtml).
86
87   Example:
88
89         \\[[!meta openid="http://joeyh.myopenid.com/"
90         server="http://www.myopenid.com/server"
91         xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]
92
93 * link
94
95   Specifies a link to another page. This can be used as a way to make the
96   wiki treat one page as linking to another without displaying a user-visible
97   [[ikiwiki/WikiLink]]:
98
99        \[[!meta link=otherpage]]
100
101   It can also be used to insert a html <link> tag. For example:
102
103        \[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
104
105   However, this latter syntax won't be allowed if the 
106   [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, since it can be used to
107   insert unsafe content.
108
109 * redir
110
111   Causes the page to redirect to another page in the wiki.
112
113         \[[!meta redir=otherpage]]
114
115   Optionally, a delay (in seconds) can be specified. The default is to
116   redirect without delay.
117
118   It can also be used to redirect to an external url. For example:
119
120         \[[!meta redir="http://example.com/"]]
121
122   However, this latter syntax won't be allowed if the 
123   [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, since it can be used to
124   insert unsafe content.
125
126   For both cases, an anchor to jump to inside the destination page may also be
127   specified using the common `#ANCHOR` syntax.
128
129 * robots
130
131   Causes the robots meta tag to be written:
132
133         \[[!meta robots="index, nofollow"]]
134
135   Valid values for the attribute are: "index", "noindex", "follow", and
136   "nofollow". Multiple comma-separated values are allowed, but obviously only
137   some combinations make sense. If there is no robots meta tag, "index,
138   follow" is used as the default.
139
140   The value is escaped, but its contents are not otherwise checked.
141
142 * guid
143
144   Specifies a globally unique ID for a page. This guid should be a URI
145   (in particular, it can be `urn:uuid:` followed by a UUID, as per
146   [[!rfc 4122]]), and it will be used to identify the page's entry in RSS
147   and Atom feeds. If not given, the default is to use the page's URL as its
148   guid.
149
150   This is mostly useful when a page has moved, to keep the guids for
151   pages unchanged and avoid_flooding_aggregators
152   (see [[!iki tips/howto_avoid_flooding_aggregators]]).
153
154 * updated
155
156   Specifies a fake modification time for a page, to be output into RSS and
157   Atom feeds. This is useful to avoid flooding aggregators that sort by
158   modification time, like Planet: for instance, when editing an old blog post
159   to add tags, you could set `updated` to be one second later than the original
160   value. The date/time can be given in any format that
161   [[!cpan TimeDate]] can understand, just like the `date` field.
162
163 If the field is not one of the above predefined fields, the metadata will be
164 written to the generated html page as a <meta> header. However, this
165 won't be allowed if the [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled,
166 since it can be used to insert unsafe content.
167
168 [[!meta robots="noindex, follow"]]