meta plugin: script support

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

diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
index c5f74fac5a8c00b25096945a6f29f4ef30f00182..9c2147264d75b35ddc4381179c369261d782214b 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.
@@ -23,12 +24,12 @@ Supported fields:
   be set to a true value in the template; this can be used to format things
   differently in this case.
 
-  An optional `sort` parameter will be used preferentially when
+  An optional `sortas` parameter will be used preferentially when
   [[ikiwiki/pagespec/sorting]] by `meta(title)`:
 
-       \[[!meta title="The Beatles" sort="Beatles, The"]]
+       \[[!meta title="The Beatles" sortas="Beatles, The"]]
 
-       \[[!meta title="David Bowie" sort="Bowie, David"]]
+       \[[!meta title="David Bowie" sortas="Bowie, David"]]
 
 * license
 
@@ -44,10 +45,10 @@ Supported fields:
 
   Specifies the author of a page.
 
-  An optional `sort` parameter will be used preferentially when
+  An optional `sortas` parameter will be used preferentially when
   [[ikiwiki/pagespec/sorting]] by `meta(author)`:
 
-       \[[!meta author="Joey Hess" sort="Hess, Joey"]]
+       \[[!meta author="Joey Hess" sortas="Hess, Joey"]]
 
 * authorurl
 
@@ -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
 
@@ -91,7 +107,7 @@ Supported fields:
 
   Example:
 
-       \\[[!meta openid="http://joeyh.myopenid.com/"
+       \[[!meta openid="http://joeyh.myopenid.com/"
        server="http://www.myopenid.com/server"
        xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]