X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f850acc6ad8a780a6b913df1099b8563647de03d..b1257eb091a89a30578a44b90957091893eada9b:/doc/plugins/meta.mdwn diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index 5c3098e56..78a8c9339 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -10,21 +10,25 @@ Enter the metadata as follows: The first form sets a given field to a given value, while the second form also specifies some additional sub-parameters. +The field values are treated as HTML entity-escaped text, so you can include +a quote in the text by writing `"` and so on. + 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: + Specifies a link to another page. This can be used as a way to make the + wiki treat one page as linking to another without displaying a user-visible + [[WikiLink]]: - \[[meta link="foo.css" rel="stylesheet" type="text/css"]] + \[[meta link=otherpage]] - A non-user-visible [[WikiLink]] would instead look like this: + It can also be used to insert a html <link> tag. For example: - \[[meta link=otherpage]] + \[[meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]] + + However, this latter syntax won't be allowed if the [[htmlscrubber]] is + enabled, since it can be used to insert unsafe content. * title @@ -43,6 +47,10 @@ You can use any field names you like, but here are some predefined ones: Specifies the author of a page. +* authorurl + + Specifies an url for the author of a page. + * permalink Specifies a permanent link to the page, if different than the page @@ -53,9 +61,24 @@ You can use any field names you like, but here are some predefined ones: Specifies the creation date of the page. The date can be entered in nearly any format, since it's parsed by [[cpan TimeDate]]. -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. +* stylesheet -The field value is treated as HTML entity-escaped text, so you can include -a quote in the text by writing `"` and so on. + Adds a stylesheet to a page. The stylesheet is treated as a wiki link to + a `.css` file in the wiki, so it cannot be used to add links to external + stylesheets. Example: + + \[[meta stylesheet=somestyle rel="alternate stylesheet" + title="somestyle"]] + +* openid + + Adds html <link> tags to perform OpenID delegation to an external + OpenID server. This lets you use an ikiwiki page as your OpenID. Example: + + \\[[meta openid="http://joeyh.myopenid.com/" + server="http://www.myopenid.com/server"]] + +If the field is not one of the above predefined fields, the metadata will be +written to the generated html page as a <meta> header. However, this +won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to +insert unsafe content.