diff options
Diffstat (limited to 'doc/plugins')
-rw-r--r-- | doc/plugins/meta.mdwn | 45 | ||||
-rw-r--r-- | doc/plugins/write.mdwn | 10 |
2 files changed, 51 insertions, 4 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)"]] diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 245f7c9ee..b2b7c6ff8 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -35,10 +35,12 @@ This is probably the most common use of a plugin. Replace "foo" with the command name that will be used inside brackers for the preprocessor directive. -Each time the directive is processed, the referenced function (`preprocess` in the example above) is called, and is passed named parameters. A -"page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included -as named parameters as well. Whatever the function returns goes onto the -page in place of the directive. +Each time the directive is processed, the referenced function (`preprocess` +in the example above) is called, and is passed named parameters. A "page" +parameter gives the name of the page that embedded the preprocessor +directive. All parameters included in the directive are included as named +parameters as well. Whatever the function returns goes onto the page in +place of the directive. ## Error handing |