X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ed30330ac23ca84235e09cfc2f0acd55d62e4a09..8d9ec24232ede981face0c3eafbce71b74c4725a:/doc/templates.mdwn?ds=inline diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 9ed9b838d..b40e865e1 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,4 +1,5 @@ -[[if test="enabled(template)" +[[!meta robots="noindex, follow"]] +[[!if test="enabled(template)" then="This wiki has templates **enabled**." else="This wiki has templates **disabled**." ]] @@ -6,14 +7,14 @@ else="This wiki has templates **disabled**." Templates are files that can be filled out and inserted into pages in the wiki. -[[if test="enabled(template) and enabled(inline)" then=""" +[[!if test="enabled(template) and enabled(inline)" then=""" ## Available templates These templates are available for inclusion onto other pages in this wiki: -[[inline pages="templates/* and !*/discussion" feeds=no archive=yes +[[!inline pages="templates/* and !*/discussion" feeds=no archive=yes sort=title template=titlepage]] """]] @@ -21,7 +22,7 @@ sort=title template=titlepage]] Using a template works like this: - \[[template id=note text="""Here is the text to insert into my note."""]] + \[[!template id=note text="""Here is the text to insert into my note."""]] This fills out the [[note]] template, filling in the `text` field with the specified value, and inserts the result into the page. @@ -31,7 +32,7 @@ page outside the template. Triple-quoting the value even allows quotes to be included in it. Combined with multi-line quoted values, this allows for large chunks of marked up text to be embedded into a template: - \[[template id=foo name="Sally" color="green" age=8 notes=""" + \[[!template id=foo name="Sally" color="green" age=8 notes=""" * \[[Charley]]'s sister. * "I want to be an astronaut when I grow up." * Really 8 and a half. @@ -39,15 +40,19 @@ large chunks of marked up text to be embedded into a template: ## Creating a template -To create a template, simply add a template directive to a page, and page will -provide a link that can be used to create the template. The template is a -regular wiki page, located in the `templates/` directory. +To create a template, simply add a template directive to a page, and the +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. -The template uses the syntax used by the [[cpan HTML::Template]] perl +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