X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c2fe8b9c898e11a1540adfbf17f4905ff6f7cc6f..4f1866853b6db13bc9d625d9fc6aa68a340a4611:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index ce0fd8ef8..9b8b29d23 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,5 +1,5 @@ [[Ikiwiki]] uses many templates for many purposes. By editing its templates, -you can fully customise this site. +you can fully customise its appearance, and avoid duplicate content. Ikiwiki uses the HTML::Template module as its template engine. This supports things like conditionals and loops in templates and is pretty @@ -11,15 +11,6 @@ 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` -## template files - -Template files have the extension `.tmpl`. - -Templates are located in `/usr/share/ikiwiki/templates` by default; -the `templatedir` setting can be used to make another directory be -searched first. Customised templates can also be placed inside the -"templates/" directory in your wiki's source. - [[!if test="enabled(template)" then=""" ## template pages @@ -42,16 +33,26 @@ 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:"]] +rootpage=templates postformtext="Add a new template page named:"]] """]] -## wiki templates +## template files + +Template files are unlike template pages in that they have the extension +`.tmpl`. Template files are used extensively by Ikiwiki to generate html. +They can contain html that would not normally be allowed on a wiki page. + +Template files are located in `/usr/share/ikiwiki/templates` by default; +the `templatedir` setting can be used to make another directory be +searched first. Customised template files can also be placed inside the +"templates/" directory in your wiki's source -- files placed there override +ones in the `templatedir`. -These templates are used to build the wiki. The aim is to keep almost all -html out of ikiwiki and in the templates. +Here is a full list of the template files used: * `page.tmpl` - Used for displaying all regular wiki pages. This is the - key template to customise. [[!if test="enabled(pagetemplate)" then=""" + key template to customise to change the look and feel of Ikiwiki. + [[!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.