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 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   [[ikiwiki/WikiLink]]:
  23
  24         \[[meta link=otherpage]]
  25
  26   It can also be used to insert a html &lt;link&gt; 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 * redir
  34
  35   Causes the page to redirect to another page in the wiki.
  36
  37         \[[meta redir=otherpage]]
  38
  39   Optionally, a delay (in seconds) can be specified. The default is to
  40   redirect without delay.
  41
  42   It can also be used to redirect to an external url. For example:
  43
  44         \[[meta redir="http://example.com/"]]
  45
  46   However, this latter syntax won't be allowed if the [[htmlscrubber]] is
  47   enabled, since it can be used to insert unsafe content.
  48
  49 * title
  50
  51   Overrides the title of the page, which is generally the same as the
  52   page name.
  53
  54   Note that if the title is overridden, a "title_overridden" variable will
  55   be set to a true value in the template; this can be used to format things
  56   differently in this case.
  57
  58 * license
  59
  60   Specifies a license for the page, for example, "GPL". Can contain
  61   WikiLinks.
  62
  63 * copyright
  64
  65   Specifies the copyright of the page, for example, "Copyright 2007 by
  66   Joey Hess". Can contain WikiLinks.
  67
  68 * author
  69
  70   Specifies the author of a page.
  71
  72 * authorurl
  73
  74   Specifies an url for the author of a page.
  75
  76 * permalink
  77
  78   Specifies a permanent link to the page, if different than the page
  79   generated by ikiwiki.
  80
  81 * date
  82
  83   Specifies the creation date of the page. The date can be entered in
  84   nearly any format, since it's parsed by [[cpan TimeDate]].
  85
  86 * stylesheet
  87
  88   Adds a stylesheet to a page. The stylesheet is treated as a wiki link to
  89   a `.css` file in the wiki, so it cannot be used to add links to external
  90   stylesheets. Example:
  91
  92         \[[meta stylesheet=somestyle rel="alternate stylesheet"
  93         title="somestyle"]]
  94
  95 * openid
  96
  97   Adds html &lt;link&gt; tags to perform OpenID delegation to an external
  98   OpenID server. This lets you use an ikiwiki page as your OpenID. Example:
  99
 100         \\[[meta openid="http://joeyh.myopenid.com/"
 101         server="http://www.myopenid.com/server"]]
 102
 103 If the field is not one of the above predefined fields, the metadata will be
 104 written to the generated html page as a &lt;meta&gt; header. However, this
 105 won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to
 106 insert unsafe content.