web commit by http://xtermin.us/: added my website to the list.
[ikiwiki.git] / doc / templates.mdwn
1 [[if test="enabled(template)"
2 then="This wiki has templates **enabled**."
3 else="This wiki has templates **disabled**."
4 ]]
5
6 Templates are files that can be filled out and inserted into pages in the
7 wiki.
8
9 [[if test="enabled(template) and enabled(inline)" then="""
10
11 ## Available templates
12
13 These templates are available for inclusion onto other pages in this
14 wiki:
15
16 [[inline pages="templates/* and !*/discussion" feeds=no archive=yes
17 sort=title template=titlepage]]
18 """]]
19
20 ## Using a template
21
22 Using a template works like this:
23
24         \[[template id=note text="""Here is the text to insert into my note."""]]
25
26 This fills out the [[note]] template, filling in the `text` field with
27 the specified value, and inserts the result into the page.
28
29 A value can include any markup that would be allowed in the wiki page
30 outside the template. Triple-quoting the value even allows quotes to be
31 included in it. Combined with multi-line quoted values, this allows for
32 large chunks of marked up text to be embedded into a template:
33
34         \[[template id=foo name="Sally" color="green" age=8 notes="""
35         * \[[Charley]]'s sister.
36         * "I want to be an astronaut when I grow up."
37         * Really 8 and a half.
38         """]]
39
40 ## Creating a template
41
42 To create a template, simply add a template directive to a page, and page will
43 provide a link that can be used to create the template. The template is a
44 regular wiki page, located in the `templates/` directory.
45
46 The template uses the syntax used by the
47 [cpan HTML::Template](http://search.cpan.org/search?mode=dist&query=HTML::Template)
48 perl module, which allows for some fairly complex things to be done.
49 Consult its documentation for the full syntax, but all you really need to know
50 are a few things:
51
52 * To insert the value of a variable, use `<TMPL_VAR variable>`.
53 * To make a block of text conditional on a variable being set use
54   `<TMPL_IF NAME="variable">text</TMPL_IF>`.
55 * To use one block of text if a variable is set and a second if it's not,
56   use `<TMPL_IF NAME="variable">text<TMPL_ELSE>other text</TMPL_IF>`
57
58 Here's a sample template:
59
60         <span class="infobox">
61         Name: <TMPL_VAR name><br />
62         Age: <TMPL_VAR age><br />
63         <TMPL_IF NAME="color">
64         Favorite color: <TMPL_VAR color><br />
65         <TMPL_ELSE>
66         No favorite color.<br />
67         </TMPL_IF>
68         <TMPL_IF NAME="notes">
69         <hr />
70         <TMPL_VAR notes>
71         </TMPL_IF>
72         </span>
73
74 The filled out template will be formatted the same as the rest of the page
75 that contains it, so you can include WikiLinks and all other forms of wiki
76 markup in the template. Note though that such WikiLinks will not show up as
77 backlinks to the page that uses the template.