test alternative header link name

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

diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn
index 22767de43d3c7efcb9613cdc89d627c2c3c7a9e2..70bd2ad258c78c2a2655544323e127fa9a09d459 100644 (file)
--- a/doc/ikiwiki/directive/edittemplate.mdwn
+++ b/doc/ikiwiki/directive/edittemplate.mdwn
@@ -18,29 +18,37 @@ the directive displaying a note about the template being registered, add
 "silent=yes".
 
 Often the template page contains a simple skeleton for a particular type of
 "silent=yes".
 
 Often the template page contains a simple skeleton for a particular type of

-page. For the bug report pages in the above example, it might look
-something like:
+page, wrapped in a [[templatebody]] directive. For the bug report pages in
+the above example, it might look something like:

 
 

+       \[[!templatebody <<ENDBODY

        Package: 
        Version: 
        Reproducible: y/n
        Details:
        Package: 
        Version: 
        Reproducible: y/n
        Details:

+       ENDBODY]]

 
 The template page can also contain [[!cpan HTML::Template]] directives,
 like other ikiwiki [[templates]].
 
 
 The template page can also contain [[!cpan HTML::Template]] directives,
 like other ikiwiki [[templates]].
 

-Four variables might be set:
+These variables might be set:

 
 * `<TMPL_VAR name>` is replaced with the name of the page being
   created.
   
 
 * `<TMPL_VAR name>` is replaced with the name of the page being
   created.
   

-* `<TMPL_VAR uuid>` is replaced with a version 4 (random) UUID.
+* `<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)
   (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, `%Y-%m-%d %H:%M:%S`.
+  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]]).

 
 

-* `<TMPL_VAR formatted_time` is replaced with the current (template
-  generation) time, formatted by IkiWiki.
+Text outside the [[templatebody]] directive is not part of the template,
+and can be used to document it.
+
+If the template does not contain a [[templatebody]] directive, the entire
+source of the page is used for the template. This is deprecated.

 
 [[!meta robots="noindex, follow"]]
 
 [[!meta robots="noindex, follow"]]