git.oblomov.eu Git - ikiwiki/blob - doc/plugins/meta.mdwn

   1 This plugin allows inserting arbitrary metadata into the source of a page.
   2 Enter the metadata as follows:
   3
   4         \[[meta field="value"]]
   5         \[[meta field="value" param="value" param="value"]]
   6
   7 The first form sets a given field to a given value, while the second form
   8 also specifies some additional sub-parameters.
   9
  10 You can use any field names you like, but here are some predefined ones:
  11
  12 * link
  13
  14   Specifies a link to another page. This is used to generate a html
  15   &lt;link&gt; tag, and also as a way to make the wiki treat one page as
  16   linking to another without displaying a user-visible link. The latter
  17   can be useful when using links to categorise pages. A html link tag
  18   would look like this:
  19
  20         \[[meta link="foo.css" rel="stylesheet" type="text/css"]]
  21
  22   A non-user-visible [[WikiLink]] would instead look like this:
  23
  24         \[[meta link=otherpage]]
  25
  26 * title
  27
  28   Overrides the title of the page, which is generally the same as the
  29   page name.
  30
  31   Note that if the title is overrideen, a "title_overridden" variable will
  32   be set to a true value in the template; this can be used to format things
  33   differently in this case.
  34
  35 * license
  36
  37   Specifies a copyright license for the page, for example, "GPL".
  38
  39 * author
  40
  41   Specifies the author of a page.
  42
  43 * permalink
  44
  45   Specifies a perminent link to the page, if different than the page
  46   generated by ikiwiki.
  47
  48 If the field is not treated specially (as the link and title fields are),
  49 the metadata will be written to the generated html page as a &lt;meta&gt;
  50 header.
  51
  52 The field value is treated as HTML entity-escaped text, so you can include
  53 a quote in the text by writing `&quot;` and so on.
  54
  55 This plugin is included in ikiwiki, but it is not enabled by default. If
  56 it is enabled, the title of this page will say it is.
  57 [[meta title="meta plugin (enabled)"]]
  58
  59 [[tag type/meta]]