WC lock idea and patch with stub functions

[git.ikiwiki.info.git] / doc / plugins / template.mdwn

diff --git a/doc/plugins/template.mdwn b/doc/plugins/template.mdwn
index 6f38e554eca488cfdbc92e5ddb3a6ae132e8b438..98188d7dc480b75604a34b6bd6e98024d5d5e883 100644 (file)
--- a/doc/plugins/template.mdwn
+++ b/doc/plugins/template.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=template included=1 author="""[[Joey]]"""]]
+[[template id=plugin name=template author="[[Joey]]"]]
 [[tag type/format]]
 
 With this plugin, you can set up templates, and cause them to be filled out
@@ -25,11 +25,12 @@ large chunks of marked up text to be embedded into a template:
 
 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]] used to build the wiki itself, which is not inside the wiki.
+[[templates]] used to build the wiki itself, which is not part of the wiki.
 
-The template uses the syntax used by the 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:
+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 `<TMPL_VAR variable>`.
 * To make a block of text conditional on a variable being set use
@@ -52,3 +53,8 @@ Here's a sample template:
        <TMPL_VAR notes>
        </TMPL_IF>
        </span>
+
+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.