From 46d295eff558e247b05e61038bd82d5c5b8155a7 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Thu, 14 Oct 2010 13:38:27 +0200 Subject: Sync with ikiwiki 3.20100926. --- ikiwiki/directive/template.mdwn | 86 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 ikiwiki/directive/template.mdwn (limited to 'ikiwiki/directive/template.mdwn') diff --git a/ikiwiki/directive/template.mdwn b/ikiwiki/directive/template.mdwn new file mode 100644 index 0000000..0e53b03 --- /dev/null +++ b/ikiwiki/directive/template.mdwn @@ -0,0 +1,86 @@ +Die `template`-Anweisung wird durch die [[!iki plugins/template +desc=template]]-Erweiterung bereitgestellt. + +The template directive allows wiki pages to be used as templates. These +templates can be filled out and inserted into other pages in the wiki using +the directive. The [[templates]] page lists templates that can be used with +this directive. + +The directive has an `id` parameter that identifies the template to use. The +remaining parameters are used to fill out the template. + +## Example + + \[[!template id=note text="""Hier ist der Text, der in meine Notiz eingefügt werden soll."""]] + +Dies füllt die Vorlage `note` aus, wobei das Feld `text` mit dem angegebenen +Wert gefüllt wird, und fügt das Ergebnis in die Seite ein. + +## Using a template + +Generally, a value can include any markup that would be allowed in the wiki +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=""" + * \[[Charley]]'s sister. + * "I want to be an astronaut when I grow up." + * Really 8 and a half. + """]] + +## Creating 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, 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 + to html, use ``. +* To make a block of text conditional on a variable being set use `text`. +* To use one block of text if a variable is set and a second if it's not, + use `textother text` + +Here's a sample template: + + + Name: \[[]]
+ Age:
+ + Favorite color:
+ + No favorite color.
+ + +
+ + + + +The filled out template will be formatted the same as the rest of the page +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 [[ikiwiki/WikiLink]] generator in the +example above. 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]]. + + +[[!meta robots="noindex, follow"]] -- cgit v1.2.3