X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/909a901424d17fb2e33a31e3fb36a9708ac0efea..cd8ec309d26cbc3f634328cb90e4c9d38b404632:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 205cb5b04..07531ae98 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,3 +1,4 @@ +[[!meta robots="noindex, follow"]] [[!if test="enabled(template)" then="This wiki has templates **enabled**." else="This wiki has templates **disabled**." @@ -8,8 +9,6 @@ wiki. [[!if test="enabled(template) and enabled(inline)" then=""" -## Available templates - These templates are available for inclusion onto other pages in this wiki: @@ -44,11 +43,20 @@ page will provide a link that can be used to create the 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, +as files with the extension ".tmpl". +By default, these are searched for in `/usr/share/ikiwiki/templates`; +the `templatedir` setting can be used to make another directory be searched +first.) + 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 documentation for the full syntax, but all you really need to know are a few things: +* Each parameter you pass to the template directive will generate a + template variable. There are also some pre-defined variables like PAGE + and BASENAME. * To insert the value of a variable, use ``. Wiki markup in the value will first be converted to html. * To insert the raw value of a variable, with wiki markup not yet converted @@ -61,7 +69,7 @@ few things: Here's a sample template: - Name: [[]]
+ Name: \[[]]
Age:
Favorite color:
@@ -79,6 +87,7 @@ that contains it, so you can include WikiLinks and all other forms of wiki markup in the template. Note though that such WikiLinks will not show up as backlinks to the page that uses the template. -Note the use of "raw_name" inside the [[WikiLink]] generator. This ensures -that if the name contains something that might be mistaken for wiki markup, -it's not converted to html before being processed as a [[WikiLink]]. +Note the use of "raw_name" inside the [[ikiwiki/WikiLink]] generator. This +ensures that if the name contains something that might be mistaken for wiki +markup, it's not converted to html before being processed as a +[[ikiwiki/WikiLink]].