X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/6c5e24f2a16a7e2ba6c46d231d5c5eaf31edd29b..91478dbbe398a35bed9d12b90e48c23969f7b289:/doc/ikiwiki/directive/meta.mdwn diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn index 72cfc6f56..3df176c48 100644 --- a/doc/ikiwiki/directive/meta.mdwn +++ b/doc/ikiwiki/directive/meta.mdwn @@ -13,7 +13,7 @@ per `meta` directive, use more directives if you want to specify more fields. The field values are treated as HTML entity-escaped text, so you can include a quote in the text by writing `"` and so on. -Supported fields: +## Supported fields * title @@ -59,6 +59,15 @@ Supported fields: Specifies a short description for the page. This will be put in the html header, and can also be displayed by eg, the [[map]] directive. +* keywords + + Specifies keywords summarizing the contents of the page. This + information will be put in the html header. Only letters, + numbers, spaces and commas are allowed in this string; other + characters are stripped. Note that the majority of search + engines, including Google, do not use information from the + keywords header. + * permalink Specifies a permanent link to the page, if different than the page @@ -127,14 +136,20 @@ Supported fields: [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, since it can be used to insert unsafe content. +* enclosure + + Specifies a link to a file to be rendered as an "enclosure" in + RSS/Atom feeds (and a plain old link in HTML). Useful for + [[!iki podcast desc=podcasting]]. + * redir Causes the page to redirect to another page in the wiki. \[[!meta redir=otherpage]] - Optionally, a delay (in seconds) can be specified. The default is to - redirect without delay. + The default is to redirect without delay. + Optionally, a delay (in seconds) can be specified: "delay=10" It can also be used to redirect to an external url. For example: @@ -189,9 +204,25 @@ Supported fields: \[[!meta foaf=foaf.rdf]] +* name + + Adds a HTML `` header with this `name` attribute. Its other attributes are + taken from the other parameters, so for example + `\[[!meta name="foo" content="bar" x-non-standard-attribute="baz"]]` + becomes ``. This + won't be allowed if the [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, + since it can be used to insert unsafe content. + +## Other fields + 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 [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, -since it can be used to insert unsafe content. +written to the generated html page as a <meta> header. For example, +`\[[!meta foo="bar"]]` becomes ``. As +with `name`, this won't be allowed if the [[!iki plugins/htmlscrubber +desc=htmlscrubber]] plugin is enabled. + +This syntax cannot be used for meta headers with unusual names, in +particular names containing `:` such as `flattr:id` and `twitter:card`. +Please use `\[[!meta name="..." content="..."]]` for those headers. [[!meta robots="noindex, follow"]]