diff options
Diffstat (limited to 'doc/plugins/meta.mdwn')
| -rw-r--r-- | doc/plugins/meta.mdwn | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn new file mode 100644 index 000000000..371713a31 --- /dev/null +++ b/doc/plugins/meta.mdwn @@ -0,0 +1,45 @@ +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"]] + +The first form sets a given field to a given value, while the second form +also specifies some additional sub-parameters. + +You can use any field names you like, but here are some predefined ones: + +* link + + Specifies a link to another page. This is used to generate a html + <link> tag, and also as a way to make the wiki treat one page as + linking to another without displaying a user-visible link. The latter + 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"]] + + A non-user-visible [[WikiLink]] would instead look like this: + + \\[[meta link=otherpage]] + +* title + + Overrides the title of the page, which is generally the same as the + page name. + +* license + + Specifies a copyright license for the page, for example, "GPL". + +* author + + Specifies the author of a page. + +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. +[[meta title="meta plugin (enabled)"]] |