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
supports things like conditionals and loops in templates and is pretty
-easy to learn. All you really need to know are a few things:
+easy to learn. All you really need to know to modify templates is this:
* To insert the value of a template variable, use `<TMPL_VAR variable>`.
* To make a block of text conditional on a variable being set use
- `<TMPL_IF NAME="variable">text</TMPL_IF>`.
+ `<TMPL_IF variable>text</TMPL_IF>`.
* To use one block of text if a variable is set and a second if it's not,
- use `<TMPL_IF NAME="variable">text<TMPL_ELSE>other text</TMPL_IF>`
+ use `<TMPL_IF variable>text<TMPL_ELSE>other text</TMPL_IF>`
[[!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 !*/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 as out 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
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`.)"""]]
-* `misc.tmpl` - Generic template used for any page that doesn't
- have a custom template.
+ 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.
* `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` - Parts of ikiwiki's user
+ interface; do not normally need to be customised.
[[!meta robots="noindex, follow"]]