X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d73eb7d9b2569ebb44fc79480b6ec2d8c1faea5d..18695056917a2f34a36e5e89df7f01deff9ab640:/doc/plugins/template.mdwn diff --git a/doc/plugins/template.mdwn b/doc/plugins/template.mdwn index 4efab57e3..3485fe64c 100644 --- a/doc/plugins/template.mdwn +++ b/doc/plugins/template.mdwn @@ -1,64 +1,7 @@ -[[template id=plugin name=template author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=template author="[[Joey]]"]] +[[!tag type/format]] +This plugin provides the [[ikiwiki/directive/template]] [[ikiwiki/directive]]. 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.