X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/c5919df5f3697e0f8968e2b8f49cd15c1e0aa412..1f085aa76d3235e275eaefe4b7c33de1455e742f:/doc/plugins/meta.mdwn diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index cacb462c9..84d48d8ef 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -1,3 +1,6 @@ +[[template id=plugin name=meta included=1 author="""[[Joey]]"""]] +[[tag type/meta]] + This plugin allows inserting arbitrary metadata into the source of a page. Enter the metadata as follows: @@ -28,6 +31,10 @@ You can use any field names you like, but here are some predefined ones: Overrides the title of the page, which is generally the same as the page name. + Note that if the title is overrideen, a "title_overridden" variable will + be set to a true value in the template; this can be used to format things + differently in this case. + * license Specifies a copyright license for the page, for example, "GPL". @@ -38,7 +45,8 @@ You can use any field names you like, but here are some predefined ones: * permalink - Specifies the permalink to the page, for use in RSS feeds. + Specifies a permanent link to the page, if different than the page + generated by ikiwiki. 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> @@ -47,8 +55,5 @@ header. 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. +If this plugin is enabled, the title of this page will say that it is. [[meta title="meta plugin (enabled)"]] - -[[tag type/meta]]