X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d534483b9befc360b3d973091b1b7f5692f15a6e..c5919df5f3697e0f8968e2b8f49cd15c1e0aa412:/doc/plugins/meta.mdwn diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index 371713a31..cacb462c9 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -1,8 +1,8 @@ This plugin allows inserting arbitrary metadata into the source of a page. Enter the metadata as follows: - \\[[meta field="value"]] - \\[[meta field="value" param="value" param="value"]] + \[[meta field="value"]] + \[[meta field="value" param="value" param="value"]] The first form sets a given field to a given value, while the second form also specifies some additional sub-parameters. @@ -17,11 +17,11 @@ You can use any field names you like, but here are some predefined ones: can be useful when using links to categorise pages. A html link tag would look like this: - \\[[meta link="foo.css" rel="stylesheet" type="text/css"]] + \[[meta link="foo.css" rel="stylesheet" type="text/css"]] A non-user-visible [[WikiLink]] would instead look like this: - \\[[meta link=otherpage]] + \[[meta link=otherpage]] * title @@ -36,10 +36,19 @@ You can use any field names you like, but here are some predefined ones: Specifies the author of a page. +* permalink + + Specifies the permalink to the page, for use in RSS feeds. + If the field is not treated specially (as the link and title fields are), the metadata will be written to the generated html page as a <meta> header. -This plugin is not enabled by default. If it is enabled, the title of this -page will say it is. +The field value is treated as HTML entity-escaped text, so you can include +a quote in the text by writing `"` and so on. + +This plugin is included in ikiwiki, but it is not enabled by default. If +it is enabled, the title of this page will say it is. [[meta title="meta plugin (enabled)"]] + +[[tag type/meta]]