X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c0b2334815303d4dc2fdf0b22dff12085671c8d8..dccd76487151acc6adc93ec79f1808096bc41324:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 0e54ae8a0..d7480ee8f 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,45 +1,52 @@ [[Ikiwiki]] uses many templates for many purposes. By editing its templates, 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 +"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 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)" 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:"]] -"""]] -[[!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!"]] -"""]] [[!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 +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 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 customize. -[[!if test="enabled(pagetemplate)" then=""" + 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. + 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. @@ -66,26 +73,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. - -## 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. - -## 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` + `passwordmail.tmpl`, `openid-selector.tmpl` - Parts of ikiwiki's user + interface; do not normally need to be customised. [[!meta robots="noindex, follow"]]