Merge branch 'master' into debian-jessie-backports

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

diff --git a/doc/ikiwiki/directive/template.mdwn b/doc/ikiwiki/directive/template.mdwn
index df391f99e0a23dd7cda85a8c29c1aef80baa707f..dd1ca3d5250d7b75dd29dc64b1385dfca1a516d8 100644 (file)
--- a/doc/ikiwiki/directive/template.mdwn
+++ b/doc/ikiwiki/directive/template.mdwn
@@ -31,16 +31,25 @@ large chunks of marked up text to be embedded into a template:
 
 ## Creating a template
 
-The template is a regular wiki page, located in the `templates/`
+The template is in a regular wiki page, located in the `templates/`
 subdirectory inside the source directory of the wiki.
+The contents of the [[templatebody]] directive are used as the
+template. Anything outside that directive is not included in the template,
+and is usually used as documentation describing the template.
+
+If the template does not contain a [[templatebody]] directive, the entire
+source of the page is used for the template. This is deprecated, because
+it leads to the template markup being interpreted as ordinary
+page source when the page is built, as well as being used as the template.
 
 Alternatively, templates can be stored in a directory outside the wiki,
 as files with the extension ".tmpl".
 By default, these are searched for in `/usr/share/ikiwiki/templates`,
 the `templatedir` setting can be used to make another directory be searched
 first.  When referring to templates outside the wiki source directory, the "id"
-parameter is not interpreted as a pagespec, and you must include the full filename
-of the template page, including the ".tmpl" extension. E.g.:
+parameter is not interpreted as a pagespec, you must include the full filename
+of the template page including the ".tmpl" extension,
+and the templatebody directive is not used. E.g.:
 
     \[[!template id=blogpost.tmpl]]
 
@@ -60,30 +69,27 @@ few things:
   `<TMPL_IF variable>text</TMPL_IF>`.
 * To use one block of text if a variable is set and a second if it's not,
   use `<TMPL_IF variable>text<TMPL_ELSE>other text</TMPL_IF>`
-* Each template file included in the wiki's source will also generate a regular
-  wiki page.  In many cases you might want to prevent some of your template
-  being interpreted for the regular page.  Use the [[if]] directive with the
-  `included()` test to guard the template code.
 
 Here's a sample template:
 
-        \[[!if test="included()" then="""
-          <span class="infobox">
-          Name: \[[<TMPL_VAR raw_name>]]<br />
-          Age: <TMPL_VAR age><br />
-          <TMPL_IF color>
-            Favorite color: <TMPL_VAR color><br />
-          <TMPL_ELSE>
-            No favorite color.<br />
-          </TMPL_IF>
-          <TMPL_IF notes>
-            <hr />
-            <TMPL_VAR notes>
-          </TMPL_IF>
-          </span>
-        """ else="""
-          This is a template page.
-        """]]
+        \[[!templatebody <<ENDBODY
+        <span class="infobox">
+        Name: \[[<TMPL_VAR raw_name>]]<br />
+        Age: <TMPL_VAR age><br />
+        <TMPL_IF color>
+        Favorite color: <TMPL_VAR color><br />
+        <TMPL_ELSE>
+        No favorite color.<br />
+        </TMPL_IF>
+        <TMPL_IF notes>
+        <hr />
+        <TMPL_VAR notes>
+        </TMPL_IF>
+        </span>
+        ENDBODY]]
+
+       This template describes a person. Parameters: name, age,
+       color (favorite color, optional), notes (optional).
 
 The filled out template will be formatted the same as the rest of the page
 that contains it, so you can include WikiLinks and all other forms of wiki