X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/4f1866853b6db13bc9d625d9fc6aa68a340a4611..cf1290eb464f1256aa5c12d973fff774e4f83e5e:/doc/templates.mdwn?ds=sidebyside diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 9b8b29d23..378e579ba 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -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 `textother text` -[[!if test="enabled(template)" then=""" +[[!if test="enabled(template) or enabled(edittemplate)" then=""" ## 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 -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=""" -## 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. @@ -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=""" -## 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:"]] """]] +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 @@ -78,10 +85,16 @@ 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. +* `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. + `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"]]