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 `&quot;` and so on.
  15
  16 Supported fields:
  17
  18 * title
  19
  20   Overrides the title of the page, which is generally the same as the
  21   page name.
  22
  23   Note that if the title is overridden, a "title_overridden" variable will
  24   be set to a true value in the template; this can be used to format things
  25   differently in this case.
  26
  27 * license
  28
  29   Specifies a license for the page, for example, "GPL". Can contain
  30   WikiLinks and arbitrary markup.
  31
  32 * copyright
  33
  34   Specifies the copyright of the page, for example, "Copyright 2007 by
  35   Joey Hess". Can contain WikiLinks and arbitrary markup.
  36
  37 * author
  38
  39   Specifies the author of a page.
  40
  41 * authorurl
  42
  43   Specifies an url for the author of a page.
  44
  45 * permalink
  46
  47   Specifies a permanent link to the page, if different than the page
  48   generated by ikiwiki.
  49
  50 * date
  51
  52   Specifies the creation date of the page. The date can be entered in
  53   nearly any format, since it's parsed by [[cpan TimeDate]].
  54
  55 * stylesheet
  56
  57   Adds a stylesheet to a page. The stylesheet is treated as a wiki link to
  58   a `.css` file in the wiki, so it cannot be used to add links to external
  59   stylesheets. Example:
  60
  61         \[[!meta stylesheet=somestyle rel="alternate stylesheet"
  62         title="somestyle"]]
  63
  64 * openid
  65
  66   Adds html &lt;link&gt; tags to perform OpenID delegation to an external
  67   OpenID server (for `openid` and `openid2`). An optional `xrds-location`
  68   parameter lets you specify the location of any [eXtensible Resource
  69   DescriptorS](http://www.windley.com/archives/2007/05/using_xrds.shtml).
  70
  71   This lets you use an ikiwiki page as your OpenID. Example:
  72
  73         \\[[!meta openid="http://joeyh.myopenid.com/"
  74         server="http://www.myopenid.com/server"
  75         xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]
  76
  77 * link
  78
  79   Specifies a link to another page. This can be used as a way to make the
  80   wiki treat one page as linking to another without displaying a user-visible
  81   [[ikiwiki/WikiLink]]:
  82
  83        \[[!meta link=otherpage]]
  84
  85   It can also be used to insert a html &lt;link&gt; tag. For example:
  86
  87        \[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
  88
  89   However, this latter syntax won't be allowed if the [[htmlscrubber]] is
  90   enabled, since it can be used to insert unsafe content.
  91
  92 * redir
  93
  94   Causes the page to redirect to another page in the wiki.
  95
  96         \[[!meta redir=otherpage]]
  97
  98   Optionally, a delay (in seconds) can be specified. The default is to
  99   redirect without delay.
 100
 101   It can also be used to redirect to an external url. For example:
 102
 103         \[[!meta redir="http://example.com/"]]
 104
 105   However, this latter syntax won't be allowed if the [[htmlscrubber]] is
 106   enabled, since it can be used to insert unsafe content.
 107
 108   For both cases, an anchor to jump to inside the destination page may also be
 109   specified using the common `PAGE#ANCHOR` syntax.
 110
 111 * robots
 112
 113   Causes the robots meta tag to be written:
 114
 115         \[[!meta robots="index, nofollow"]]
 116
 117   Valid values for the attribute are: "index", "noindex", "follow", and
 118   "nofollow". Multiple comma-separated values are allowed, but obviously only
 119   some combinations make sense. If there is no robots meta tag, "index,
 120   follow" is used as the default.
 121
 122   The plugin escapes the value, but otherwise does not care about its
 123   contents. In particular, it does not check the values against the set of
 124   valid values but serves whatever you pass it.
 125
 126 * guid
 127
 128   Specifies a globally unique ID for a page. This guid should be a URI
 129   (in particular, it can be `urn:uuid:` followed by a UUID, as per
 130   [[!rfc 4122]]), and it will be used to identify the page's entry in RSS
 131   and Atom feeds. If not given, the default is to use the page's URL as its
 132   guid.
 133
 134   This is mostly useful when a page has moved, to keep the guids for
 135   pages unchanged and
 136   [[avoid_flooding_aggregators|howto_avoid_flooding_aggregators]].
 137
 138 If the field is not one of the above predefined fields, the metadata will be
 139 written to the generated html page as a &lt;meta&gt; header. However, this
 140 won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to
 141 insert unsafe content.