From 6d77c7796c1039d0c23fb7c1d16929bd8f78b39b Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Mon, 15 Oct 2007 15:57:38 +0200 Subject: Grab upstream pages from version 2.9. --- templates.mdwn | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 templates.mdwn (limited to 'templates.mdwn') diff --git a/templates.mdwn b/templates.mdwn new file mode 100644 index 0000000..33e02b9 --- /dev/null +++ b/templates.mdwn @@ -0,0 +1,77 @@ +[[if test="enabled(template)" +then="This wiki has templates **enabled**." +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=""" + +## Available templates + +These templates are available for inclusion onto other pages in this +wiki: + +[[inline pages="templates/* and !*/discussion" feeds=no archive=yes +sort=title template=titlepage]] +"""]] + +## Using a template + +Using a template works like this: + + \[[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. + +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 + +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. + +The template uses the syntax used by the +[cpan HTML::Template](http://search.cpan.org/search?mode=dist&query=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: + +* To insert the value of a variable, 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. -- cgit v1.2.3