aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsmcv <smcv@web>2017-05-19 09:50:52 -0400
committeradmin <admin@branchable.com>2017-05-19 09:50:52 -0400
commit778d9e50d41d7ed2c1b2a2bf5cad52f089c94122 (patch)
tree7ddde258fc0c22542357a08a7d2356020e7f7655
parent1e4e51754e6ad2b8c6e6af13a6bb0ec8697b2e75 (diff)
downloadikiwiki-778d9e50d41d7ed2c1b2a2bf5cad52f089c94122.tar
ikiwiki-778d9e50d41d7ed2c1b2a2bf5cad52f089c94122.tar.gz
Document the special case for [[!meta name=foo content=bar]]
-rw-r--r--doc/ikiwiki/directive/meta.mdwn19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
index 955648cac..0d4d9d6cc 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 `&quot;` and so on.
-Supported fields:
+## Supported fields
* title
@@ -204,9 +204,20 @@ Supported fields:
\[[!meta foaf=foaf.rdf]]
+* name
+
+ Adds a HTML `<meta>` 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 `<meta name="foo" content="bar" x-non-standard-attribute="baz">`. 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 &lt;meta&gt; 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 &lt;meta&gt; header. For example,
+`\[[!meta foo="bar"]]` becomes `<meta name="foo" content="bar">`. As with `name`, this
+won't be allowed if the [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled.
[[!meta robots="noindex, follow"]]