doc/plugins/meta.mdwn

   1 [[template id=plugin name=meta included=1 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   [[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 * 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 overrideen, 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 copyright license for the page, for example, "GPL".
  45
  46 * author
  47
  48   Specifies the author of a page.
  49
  50 * permalink
  51
  52   Specifies a permanent link to the page, if different than the page
  53   generated by ikiwiki.
  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. This lets you use an ikiwiki page as your OpenID. Example:
  68
  69         \\[[meta openid="http://joeyh.myopenid.com/"
  70         server="http://www.myopenid.com/server"]]
  71
  72 If the field is not one of the above predefined fields, the metadata will be
  73 written to the generated html page as a &lt;meta&gt; header. However, this
  74 won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to
  75 insert unsafe content.
  76
  77 If this plugin is enabled, the title of this page will say that it is.
  78 [[meta title="meta plugin (enabled)"]]