From 11334173befbc6ad710b451260ad6f080b326a00 Mon Sep 17 00:00:00 2001 From: joey Date: Sat, 19 May 2007 23:29:13 +0000 Subject: move template documentation into the basewiki, in the templates page --- doc/plugins/template.mdwn | 62 ++--------------------------------------------- doc/templates.mdwn | 58 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 60 deletions(-) (limited to 'doc') diff --git a/doc/plugins/template.mdwn b/doc/plugins/template.mdwn index 4efab57e3..daa2403cc 100644 --- a/doc/plugins/template.mdwn +++ b/doc/plugins/template.mdwn @@ -2,63 +2,5 @@ [[tag type/format]] With this plugin, you can set up templates, and cause them to be filled out -and inserted into pages in the wiki. Using a template works like this: - - \[[template id=foo name="Charley" color="red" age=11]] - -This fills out the template `templates/foo`, filling in the `color` and `age` -fields on it with the specified values, and inserts the result into the page. - -(Note that if the template doesn't exist, the page will provide a link that -can be used to create it.) - -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. - """]] - -Some templates are included in the wiki by default; these are listed in the -[[templates]] page. - -To create a template, make a page in the wiki named `template/foo`. Note -that this is a different location than the directory used for the -[[templates|wikitemplates]] used to build the wiki itself, which is not -part of the wiki. - -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: - -* 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. +and inserted into pages in the wiki. It's documented and existing templates +are listed in the [[templates]] page. diff --git a/doc/templates.mdwn b/doc/templates.mdwn index bd8b2b6fe..acbcd4c8a 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -3,6 +3,9 @@ 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=""" These templates are available for inclusion onto other pages in this wiki: @@ -10,3 +13,58 @@ wiki: [[inline pages="templates/* and !*/discussion" feeds=no archive=yes sort=title template=titlepage]] """]] + +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. + """]] + +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