updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / templates.mdwn

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index ca3f1412a82ba9b853b83ba534752d3a6696208f..378e579ba77223133e51cf58cfea39a4f741be5e 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -14,8 +14,10 @@ easy to learn. All you really need to know to modify templates is this:
 [[!if test="enabled(template) or enabled(edittemplate)" then="""
 ## template pages
 
-Template pages are regular wiki pages that are used as templates for other
-pages.
+Template pages are regular wiki pages containing a
+[[!iki ikiwiki/directive/templatebody desc="templatebody directive"]],
+used as templates for other pages. The parts of the template
+page outside the directive can be used to document it.
 """]]
 
 [[!if test="enabled(template)" then="""
@@ -38,6 +40,9 @@ feeds=no archive=yes sort=title template=titlepage
 rootpage=templates postformtext="Add a new template page named:"]]
 """]]
 
+If the template does not contain a `templatebody` directive, the entire
+source of the page is used for the template. This is deprecated.
+
 ## template files
 
 Template files are unlike template pages in that they have the extension
@@ -82,13 +87,14 @@ Here is a full list of the template files used:
   make calendar archive pages.
 * `trails.tmpl` - Used by the trail plugin to generate links on each page
   that is a member of a trail.
-* `changemail.tmpl` - Used by the changemail plugin to generate mails about
+* `notifyemail.tmpl` - Used by the notifymail plugin to generate mails about
   changed pages.
 * `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
   `editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
   `editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,
-  `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user
-  interface; do not normally need to be customised.
+  `passwordmail.tmpl`, `emailauth.tmpl`, `login-selector.tmpl`, 
+  `revert.tmpl` - Parts of ikiwiki's user interface; do not normally need
+  to be customised.
 
 
 [[!meta robots="noindex, follow"]]