improve docs

[ikiwiki.git] / doc / ikiwiki / directive / meta.mdwn

diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
index 1f5bde964d088a31c430377ab44dd94ff60f752c..f8494dbff685c1486459bbc3798dc7b51370f3c3 100644 (file)
--- a/doc/ikiwiki/directive/meta.mdwn
+++ b/doc/ikiwiki/directive/meta.mdwn
@@ -7,7 +7,8 @@ Enter the metadata as follows:
        \[[!meta field="value" param="value" param="value"]]
 
 The first form sets a given field to a given value, while the second form
-also specifies some additional sub-parameters.
+also specifies some additional sub-parameters. You can have only one field
+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.
@@ -76,6 +77,21 @@ Supported fields:
 
        \[[!meta stylesheet=somestyle rel="alternate stylesheet"
        title="somestyle"]]
+  
+  However, this will be scrubbed away if the 
+  [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled,
+  since it can be used to insert unsafe content.
+
+* script
+
+  Adds a script to a page. The script is treated as a wiki link to
+  a `.js` file in the wiki, so it cannot be used to add links to external
+  scripts. The optional `defer` and `async` keywords can be used to set
+  the corresponding HTML4 and HTML5 script options. Example:
+
+       \[[!meta script=somescript defer async]]
+
+  The tag is subject to scrubbing as with the stylesheet and link fields.
 
 * openid
 
@@ -93,7 +109,7 @@ Supported fields:
 
        \[[!meta openid="http://joeyh.myopenid.com/"
        server="http://www.myopenid.com/server"
-       xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]
+       xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com"]]
 
 * link
 
@@ -117,8 +133,8 @@ Supported fields:
 
        \[[!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:
 
@@ -146,14 +162,13 @@ Supported fields:
 
 * guid
 
-  Specifies a globally unique ID for a page. This guid should be a URI
-  (in particular, it can be `urn:uuid:` followed by a UUID, as per
-  [[!rfc 4122]]), and it will be used to identify the page's entry in RSS
+  Specifies a globally unique ID for a page. This guid should be a URI,
+  and it will be used to identify the page's entry in RSS
   and Atom feeds. If not given, the default is to use the page's URL as its
   guid.
 
   This is mostly useful when a page has moved, to keep the guids for
-  pages unchanged and avoid_flooding_aggregators
+  pages unchanged and avoid flooding aggregators
   (see [[!iki tips/howto_avoid_flooding_aggregators]]).
 
 * updated
@@ -165,6 +180,15 @@ Supported fields:
   value. The date/time can be given in any format that
   [[!cpan TimeDate]] can understand, just like the `date` field.
 
+* foaf
+
+  Adds a Friend of a Friend ([FOAF](http://wiki.foaf-project.org/w/Autodiscovery))
+  reference to a page.
+
+  Example:
+
+       \[[!meta foaf=foaf.rdf]]
+
 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,