X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/db9f2b1b2b97fd92b09f170c3b567ec59030bf0a..3bccedd49230314f44d26aafa4391cb1217213ed:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index d189fa073..80372fcb7 100644 --- 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 @@ -80,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. +* `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. + [[!meta robots="noindex, follow"]]