git.oblomov.eu Git - ikiwiki/blob - doc/templates.mdwn

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