X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c0b2334815303d4dc2fdf0b22dff12085671c8d8..95d592bf657c934b663983bba3ef86605e469c52:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 0e54ae8a0..d0f891c21 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,45 +1,62 @@ [[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. -[[!if test="enabled(template)" then=""" +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 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`. +* To use one block of text if a variable is set and a second if it's not, + use `textother text` + +[[!if test="enabled(template) or enabled(edittemplate)" 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:"]] +Template pages are regular wiki pages that are used as templates for other +pages. """]] + [[!if test="enabled(template)" then=""" -[[!template id=note text="This note box is built using the -[[note]] template!"]] -[[!template id=popup mouseover="popup example" popup="This popup is built using -the [[popup]] template!"]] +The [[!iki ikiwiki/directive/template desc="template directive"]] allows +template pages to be filled out and inserted into other pages in the wiki. """]] [[!if test="enabled(edittemplate)" then=""" -## edit templates +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=""" +These template pages are currently available: -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. +[[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion" +feeds=no archive=yes sort=title template=titlepage +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. -These templates are used to build the wiki. The aim is to keep almost all -html out of ikiwiki and in the templates. +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`. + +Here is a full list of the template files used: * `page.tmpl` - Used for displaying all regular wiki pages. This is the - key template 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 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. * `rssitem.tmpl` - Used for generating individual items on rss feeds. * `atompage.tmpl` - Used for generating atom feeds for blogs. @@ -48,7 +65,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. @@ -63,29 +80,15 @@ html out of ikiwiki and in the templates. * `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` - Parts of ikiwiki's user interface; do not - normally need to be customised. - -## Template locations - -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 -"templates/" directory in your wiki's source. + `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user + interface; do not normally need to be customised. -## Template syntax - -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: - -* To insert the value of a template variable, use ``. -* To make a block of text conditional on a variable being set use - `text`. -* To use one block of text if a variable is set and a second if it's not, - use `textother text` [[!meta robots="noindex, follow"]]