search: Avoid '$' in the wikiname appearing unescaped on omega's query template,...

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

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 24da881c7a71e4af0741aba5065a5d833735144f..eff0e15e93d5930821677833ce4de8619658fb44 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -1,3 +1,4 @@
+[[!meta robots="noindex, follow"]]

 [[!if test="enabled(template)"
 then="This wiki has templates **enabled**."
 else="This wiki has templates **disabled**."
 [[!if test="enabled(template)"
 then="This wiki has templates **enabled**."
 else="This wiki has templates **disabled**."


@@ -8,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:
 


@@ -39,15 +38,19 @@ 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.
+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:
 
 
 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 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


@@ -60,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 />


@@ -78,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]].