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