X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7e79da76332b93214a7d9a5c91bc046db4219ee2..5430d5dc3bc37df92eb01cd65382c0f2be78b8e7:/doc/ikiwiki/directive/template.mdwn diff --git a/doc/ikiwiki/directive/template.mdwn b/doc/ikiwiki/directive/template.mdwn index 052ca7873..9e3ae54df 100644 --- a/doc/ikiwiki/directive/template.mdwn +++ b/doc/ikiwiki/directive/template.mdwn @@ -34,11 +34,15 @@ large chunks of marked up text to be embedded into a template: The template is a regular wiki page, located in the `templates/` subdirectory inside the source directory of the wiki. -(Alternatively, templates can be stored in a directory outside the wiki, +Alternatively, templates can be stored in a directory outside the wiki, as files with the extension ".tmpl". -By default, these are searched for in `/usr/share/ikiwiki/templates`; +By default, these are searched for in `/usr/share/ikiwiki/templates`, the `templatedir` setting can be used to make another directory be searched -first.) +first. When referring to templates outside the wiki source directory, the "id" +parameter is not interpreted as a pagespec, and you must include the full filename +of the template page, including the ".tmpl" extension. E.g.: + + \[[!template id=blogpost.tmpl]] The template uses the syntax used by the [[!cpan HTML::Template]] perl module, which allows for some fairly complex things to be done. Consult its @@ -53,21 +57,21 @@ few things: * To insert the raw value of a variable, with wiki markup not yet converted to html, use `<TMPL_VAR raw_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>` Here's a sample template: <span class="infobox"> Name: \[[<TMPL_VAR raw_name>]]<br /> Age: <TMPL_VAR age><br /> - <TMPL_IF NAME="color"> + <TMPL_IF color> Favorite color: <TMPL_VAR color><br /> <TMPL_ELSE> No favorite color.<br /> </TMPL_IF> - <TMPL_IF NAME="notes"> + <TMPL_IF notes> <hr /> <TMPL_VAR notes> </TMPL_IF>