X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/89df287aaa0a21d959dc2c179412a16ab08a7d51..6cde5baef6eb52e5e7c7b90ba93be416382a02b5:/doc/ikiwiki/directive/meta.mdwn diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn index 984f68540..777712f32 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 @@ -75,8 +75,13 @@ Supported fields: * date - Specifies the creation date of the page. The date can be entered in - nearly any format, since it's parsed by [[!cpan TimeDate]]. + Specifies the creation date of the page. This creates a + `` header in the HTML output, but also + modifies the internal `ctime` in the + [[!iki tips/inside_dot_ikiwiki desc="internal index"]]. + The date can be entered in nearly any format, since it's parsed by + [[!cpan TimeDate]] but invalid dates yield an error in 3.20180321 + or later. * stylesheet @@ -136,6 +141,12 @@ 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. @@ -187,7 +198,8 @@ Supported fields: modification time, like Planet: for instance, when editing an old blog post to add tags, you could set `updated` to be one second later than the original value. The date/time can be given in any format that - [[!cpan TimeDate]] can understand, just like the `date` field. + [[!cpan TimeDate]] can understand, just like the `date` field and maps to the + `` HTML header and internal `mtime` field. * foaf @@ -198,9 +210,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"]]