Merge branch 'ready/templatebody'

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

diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn
index b3177daa806af4b7bf2e37d12ee795bff97d2239..70bd2ad258c78c2a2655544323e127fa9a09d459 100644 (file)
--- a/doc/ikiwiki/directive/edittemplate.mdwn
+++ b/doc/ikiwiki/directive/edittemplate.mdwn
@@ -29,9 +29,21 @@ the above example, it might look something like:
        ENDBODY]]
 
 The template page can also contain [[!cpan HTML::Template]] directives,
        ENDBODY]]
 
 The template page can also contain [[!cpan HTML::Template]] directives,

-like other ikiwiki [[templates]]. Currently only one variable is
-set: `<TMPL_VAR name>` is replaced with the name of the page being
-created.
+like other ikiwiki [[templates]].
+
+These variables might be set:
+
+* `<TMPL_VAR name>` is replaced with the name of the page being
+  created.
+  
+* `<TMPL_VAR uuid>` is replaced with a version 4 (random) UUID
+  suitable for use in `\[[!meta guid="urn:uuid:<TMPL_VAR uuid>"]]`.
+  (Requires the `UUID::Tiny` Perl module if not running on Linux.)
+
+* `<TMPL_VAR time>` is replaced with the current (template generation)
+  time using a fixed format (RFC 3339, `%Y-%m-%dT%H:%M:%SZ`),
+  suitable for use in `\[[!meta date="<TMPL_VAR time>"]]`
+  (see [[meta]]) or `\[[!date "<TMPL_VAR time>"]]` (see [[date]]).

 
 Text outside the [[templatebody]] directive is not part of the template,
 and can be used to document it.
 
 Text outside the [[templatebody]] directive is not part of the template,
 and can be used to document it.