X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/39d37c7c1be6b8bd4ac48aa7f0f4fc04c86aa310..3fe434189b99daf3d8cc075186c4ed4ebdd43b8f:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index eb8c89afc..c45316e44 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,168 +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. - -[[!meta robots="noindex, follow"]] + `passwordmail.tmpl`, `emailauth.tmpl, `login-selector.tmpl`, + `revert.tmpl` - Parts of ikiwiki's user interface; do not normally need + to be customised. -here is a list of variables used in various tmpl files: -ACTION -ACTIONS -ADDCOMMENTURL -ATOMCOMMENTSURL -ATOMURL -ATTACHMENTS-CLASS -AUTHOR -AUTHORURL -BACKLINKS -BASEURL -BROKENLINKS -BROKENLINKS_CHECKED -CATEGORIES -CATEGORY -CDATE_3339 -CDATE_822 -CGIURL -COMMENTAUTHOR -COMMENTAUTHORURL -COMMENTID -COMMENTIP -COMMENTOPENID -COMMENTS -COMMENTSLINK -COMMENTSURL -COMMENTUSER -COMMITDATE -COMMITTYPE -CONTENT -COPYRIGHT -CTIME -DEST -DIFF -DIFFURL -DISCUSSIONLINK -DYNAMIC -EDITURL -ENCLOSURE -ERROR -ERROR_MESSAGE -EXTRAFOOTER -FAVICON -FEEDDATE -FEEDDESC -FEEDLINKS -FEEDURL -FIELD-ATTACHMENT -FIELD-DO -FIELD-EDITCONTENT -FIELD-EDITMESSAGE -FIELD-FROM -FIELD-LINK -FIELD-NEWFILE -FIELD-PAGE -FIELD-RCSINFO -FIELD-REMOVE -FIELD-RENAME -FIELD-REV -FIELD-REVERTMESSAGE -FIELD-SELECT -FIELD-SID -FIELD-SUBJECT -FIELD-TYPE -FIELD-UPLOAD -FIRST -FIXEDLINKS -FORCEBASEURL -FORCEBASEURL -form-cancel -FORM-END -FORM-START -FORM-SUBMIT -GETSOURCEURL -GUID -HAVE_ACTIONS -HELPONFORMATTINGLINK -HISTORYURL -HTML5 -ID -ISTRANSLATION -JAVASCRIPT -LANG -LANGUAGE -LAST -LENGTH -LICENSE -LINE -LINK -LOCAL_CSS -MASTER -MDATE_3339 -MESSAGE -META -MONTH -MORE_BACKLINKS -MTIME -NAME -NAME="ATTACHMENT_LIST" -NAME="ATTACHMENT_LIST" -NAME="CAN_COMMIT" -NAME="FIELD-ATTACHMENT" -NAME="FORM-END" -NAME="PAGE_DIFF" -NAME="PAGE_PREVIEW" -NAME="PAGE_PREVIEW" -NAME="PAGE_SELECT" -NAME=ALLOWAUTHOR -NAME=FIELD-AUTHOR -NAME=FIELD-URL -NAME=USERNAME -NONOPENIDFORM -OPENID_URL -OTHERLANGUAGES -PAGE -PAGE_DIFF -PAGE_PREVIEW -PAGES -PAGESPEC -PAGEURL -PARENTLINKS -PASSWORDURL -PERCENT -PERCENTTRANSLATED -PERMALINK -POSTFORMTEXT -PREFSURL -RECENTCHANGESURL -RELVCS -REMOTE_ADDR -REMOVEURL -REV -REVERTURL -ROOTPAGE -RSSURL -SEARCHACTION -SEARCHFORM -SID -SIDEBAR -SIGNINURL -SIZE -SRC -TAG -TAGNAME -TAGS -TITLE -TYPE -URL -USER -USER_NAME -VERSION -VIEW -WIKINAME -WIKIURL -WMD_PREVIEW -YEAR +[[!meta robots="noindex, follow"]]