(no commit message)

[git.ikiwiki.info.git] / doc / templates.mdwn

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 33e02b96df91f28b87d8004eabf19f7f61c278a0..eff0e15e93d5930821677833ce4de8619658fb44 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -1,4 +1,5 @@
-[[if test="enabled(template)"
+[[!meta robots="noindex, follow"]]
+[[!if test="enabled(template)"

 then="This wiki has templates **enabled**."
 else="This wiki has templates **disabled**."
 ]]
 then="This wiki has templates **enabled**."
 else="This wiki has templates **disabled**."
 ]]


@@ -6,14 +7,12 @@ else="This wiki has templates **disabled**."
 Templates are files that can be filled out and inserted into pages in the
 wiki.
 
 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
+[[!if test="enabled(template) and enabled(inline)" then="""

 
 These templates are available for inclusion onto other pages in this
 wiki:
 
 
 These templates are available for inclusion onto other pages in this
 wiki:
 

-[[inline pages="templates/* and !*/discussion" feeds=no archive=yes
+[[!inline pages="templates/* and !*/discussion" feeds=no archive=yes

 sort=title template=titlepage]]
 """]]
 
 sort=title template=titlepage]]
 """]]
 


@@ -21,17 +20,17 @@ sort=title template=titlepage]]
 
 Using a template works like this:
 
 
 Using a template works like this:
 

-       \[[template id=note text="""Here is the text to insert into my note."""]]
+       \[[!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.
 
 
 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
+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:
 
 large chunks of marked up text to be embedded into a template:
 

-        \[[template id=foo name="Sally" color="green" age=8 notes="""
+        \[[!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.
         * \[[Charley]]'s sister.
         * "I want to be an astronaut when I grow up."
         * Really 8 and a half.


@@ -39,17 +38,23 @@ large chunks of marked up text to be embedded into a template:
 
 ## Creating a template
 
 
 ## 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 `<TMPL_VAR variable>`.
+To create a template, simply add a template directive to a page, and the 
+page will provide a link that can be used to create the template. The template
+is a regular wiki page, located in the `templates/` subdirectory inside
+the source directory 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:
+
+* 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 `<TMPL_VAR variable>`. 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 `<TMPL_VAR raw_variable>`.

 * To make a block of text conditional on a variable being set use
   `<TMPL_IF NAME="variable">text</TMPL_IF>`.
 * To use one block of text if a variable is set and a second if it's not,
 * To make a block of text conditional on a variable being set use
   `<TMPL_IF NAME="variable">text</TMPL_IF>`.
 * To use one block of text if a variable is set and a second if it's not,


@@ -58,7 +63,7 @@ are a few things:
 Here's a sample template:
 
         <span class="infobox">
 Here's a sample template:
 
         <span class="infobox">

-        Name: <TMPL_VAR name><br />
+        Name: \[[<TMPL_VAR raw_name>]]<br />

         Age: <TMPL_VAR age><br />
         <TMPL_IF NAME="color">
         Favorite color: <TMPL_VAR color><br />
         Age: <TMPL_VAR age><br />
         <TMPL_IF NAME="color">
         Favorite color: <TMPL_VAR color><br />


@@ -75,3 +80,8 @@ 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.
 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. 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]].