switched my DreamHost install to pkgsrc, happily

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

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 58d5d11461f77194036c30b919f61d42a53e2dc3..eff0e15e93d5930821677833ce4de8619658fb44 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -9,8 +9,6 @@ wiki.
 
 [[!if test="enabled(template) and enabled(inline)" then="""
 
 
 [[!if test="enabled(template) and enabled(inline)" then="""
 

-## Available templates
-

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


@@ -50,6 +48,9 @@ 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:
 
 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 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


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

-        Name: [[<TMPL_VAR raw_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 />


@@ -80,6 +81,7 @@ 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.
 
 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 [[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 [[WikiLink]].
+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]].