(no commit message)

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

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 2eb1df49444edba7f4c705e51d9b31ca562c37eb..80372fcb7742ff17d87ce969d40bb31e7c0f8d36 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -1,5 +1,5 @@
 [[Ikiwiki]] uses many templates for many purposes. By editing its templates,
 [[Ikiwiki]] uses many templates for many purposes. By editing its templates,

-you can fully customise this site.
+you can fully customise its appearance, and avoid duplicate content.

 
 Ikiwiki uses the HTML::Template module as its template engine. This
 supports things like conditionals and loops in templates and is pretty
 
 Ikiwiki uses the HTML::Template module as its template engine. This
 supports things like conditionals and loops in templates and is pretty


@@ -11,17 +11,21 @@ easy to learn. All you really need to know to modify templates is this:
 * 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>`
 
 * 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>`
 

-[[!if test="enabled(template)" then="""
+[[!if test="enabled(template) or enabled(edittemplate)" then="""

 ## template pages
 
 ## template 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="""

 The [[!iki ikiwiki/directive/template desc="template directive"]] allows
 The [[!iki ikiwiki/directive/template desc="template directive"]] allows

-wiki pages to be used as templates, filled out and inserted into other
-pages in the wiki.
+template pages to be filled out and inserted into other pages in the wiki.

 """]]
 
 [[!if test="enabled(edittemplate)" then="""
 """]]
 
 [[!if test="enabled(edittemplate)" then="""

-## default content for new pages
-

 The [[!iki ikiwiki/directive/edittemplate desc="edittemplate directive"]] can
 be used to make new pages default to containing text from a template
 page, which can be filled out as the page is edited.
 The [[!iki ikiwiki/directive/edittemplate desc="edittemplate directive"]] can
 be used to make new pages default to containing text from a template
 page, which can be filled out as the page is edited.


@@ -29,13 +33,16 @@ page, which can be filled out as the page is edited.
 
 [[!if test="(enabled(template) or enabled(edittemplate))
 and enabled(inline)" then="""
 
 [[!if test="(enabled(template) or enabled(edittemplate))
 and enabled(inline)" then="""

-## available template pages
+These template pages are currently available:

 
 [[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion"
 feeds=no archive=yes sort=title template=titlepage
 rootpage=templates postformtext="Add a new template page named:"]]
 """]]
 
 
 [[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion"
 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
 ## template files
 
 Template files are unlike template pages in that they have the extension


@@ -51,7 +58,7 @@ ones in the `templatedir`.
 Here is a full list of the template files used:
 
 * `page.tmpl` - Used for displaying all regular wiki pages. This is the
 Here is a full list of the template files used:
 
 * `page.tmpl` - Used for displaying all regular wiki pages. This is the

-  key template to customise to change the look and feel of your site.
+  key template to customise to change the look and feel of Ikiwiki.

   [[!if test="enabled(pagetemplate)" then="""
   (The [[!iki ikiwiki/directive/pagetemplate desc="pagetemplate directive"]]
   can be used to make a page use a different template than `page.tmpl`.)"""]]
   [[!if test="enabled(pagetemplate)" then="""
   (The [[!iki ikiwiki/directive/pagetemplate desc="pagetemplate directive"]]
   can be used to make a page use a different template than `page.tmpl`.)"""]]


@@ -78,10 +85,15 @@ Here is a full list of the template files used:
 * `autotag.tmpl` - Filled in by the tag plugin to make tag pages.
 * `calendarmonth.tmpl`, `calendaryear.tmpl` - Used by ikiwiki-calendar to
   make calendar archive pages.
 * `autotag.tmpl` - Filled in by the tag plugin to make tag pages.
 * `calendarmonth.tmpl`, `calendaryear.tmpl` - Used by ikiwiki-calendar to
   make calendar archive pages.

+* `trails.tmpl` - Used by the trail plugin to generate links on each page
+  that is a member of a trail.
+* `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.
 
 * `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.
 

+

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