X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/66cc23a591f25344072deb07b2ccc7a4d4c89047..490e0813c53ce7cff708ae4b6c2805c643f9f005:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 2444cf14d..4fd2bf501 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -3,7 +3,7 @@ you can fully customise this site. Templates are located in `/usr/share/ikiwiki/templates` by default; the `templatedir` setting can be used to make another directory be -searched first. Customized templates can also be placed inside the +searched first. Customised templates can also be placed inside the "templates/" directory in your wiki's source. Ikiwiki uses the HTML::Template module as its template engine. This @@ -12,28 +12,31 @@ easy to learn. All you really need to know to modify templates is this: * To insert the value of a template variable, use ``. * To make a block of text conditional on a variable being set use - `text`. + `text`. * To use one block of text if a variable is set and a second if it's not, - use `textother text` + use `textother text` [[!if test="enabled(template)" then=""" ## template pages -The template directive allows wiki pages to be used as templates, -filled out and inserted into other pages in the wiki. -"""]] -[[!if test="enabled(template) and enabled(inline)" then=""" -[[!inline pages="templates/* and !*.tmpl and !*/discussion" -feeds=no archive=yes sort=title template=titlepage -rootpage=templates postformtext="Add a new template named:"]] +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. """]] [[!if test="enabled(edittemplate)" then=""" -## edit templates +## default content for new pages -The edittemplate directive can be used to make new pages default to -containing text from a template, which can be filled as out 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. +"""]] + +[[!if test="(enabled(template) or enabled(edittemplate)) +and enabled(inline)" then=""" +[[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion" +feeds=no archive=yes sort=title template=titlepage +rootpage=templates postformtext="Add a new template named:"]] """]] ## wiki templates @@ -42,9 +45,9 @@ These templates are used to build the wiki. The aim is to keep almost all html out of ikiwiki and in the templates. * `page.tmpl` - Used for displaying all regular wiki pages. This is the - key template to customize. [[!if test="enabled(pagetemplate)" then=""" - (The pagetemplate directive can be used to make a page use a - different template than `page.tmpl`.)"""]] + key template to customise. [[!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`.)"""]] * `rsspage.tmpl` - Used for generating rss feeds for blogs. * `rssitem.tmpl` - Used for generating individual items on rss feeds. * `atompage.tmpl` - Used for generating atom feeds for blogs. @@ -53,7 +56,7 @@ html out of ikiwiki and in the templates. * `archivepage.tmpl` - Used for listing a page in a blog archive page. * `titlepage.tmpl` - Used for listing a page by title in a blog archive page. * `microblog.tmpl` - Used for showing a microblogging post inline. -* `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links) +* `blogpost.tmpl` - Used for a form to add a post to a blog (and rss/atom links) * `feedlink.tmpl` - Used to add rss/atom links if `blogpost.tmpl` is not used. * `aggregatepost.tmpl` - Used by the aggregate plugin to create a page for a post. @@ -71,7 +74,7 @@ html out of ikiwiki and in the templates. * `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`, `editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`, `editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`, - `passwordmail.tmpl` - Parts of ikiwiki's user interface; do not - normally need to be customised. + `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user + interface; do not normally need to be customised. [[!meta robots="noindex, follow"]]