aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-04-23 15:32:39 -0400
committerJoey Hess <joey@kitenet.net>2010-04-23 15:33:32 -0400
commitd822e37d0efc34f2267f275030de11cd3c7ff7bb (patch)
tree7b427aa8b3a27f7a83ba7b19803cd0144918d053
parent796ece2a8a482f219a5d4c568af271286511574e (diff)
downloadikiwiki-d822e37d0efc34f2267f275030de11cd3c7ff7bb.tar
ikiwiki-d822e37d0efc34f2267f275030de11cd3c7ff7bb.tar.gz
move template documentation to the template directive
allow new templates to be created via the inline that lists them (cherry picked from commit 83703d2f4a8832155e3c111792489062ccc4793b)
-rw-r--r--doc/ikiwiki/directive/template.mdwn71
-rw-r--r--doc/templates.mdwn82
2 files changed, 71 insertions, 82 deletions
diff --git a/doc/ikiwiki/directive/template.mdwn b/doc/ikiwiki/directive/template.mdwn
index d538b69b1..ae71ba5b5 100644
--- a/doc/ikiwiki/directive/template.mdwn
+++ b/doc/ikiwiki/directive/template.mdwn
@@ -5,14 +5,79 @@ wiki, by using the template directive. The directive has an `id` parameter
that identifies the template to use. The remaining parameters are used to
fill out the template.
-Example:
+## Example
\[[!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.
-For a list of available templates, and details about how to create more,
-see the [[templates]] page.
+## Using a template
+
+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:
+
+ \[[!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.
+ """]]
+
+## Creating a template
+
+The template is a regular wiki page, located in the `templates/`
+subdirectory inside the source directory of the wiki.
+
+(Alternatively, templates can be stored in a directory outside the wiki,
+as files with the extension ".tmpl".
+By default, these are searched for in `/usr/share/ikiwiki/templates`;
+the `templatedir` setting can be used to make another directory be searched
+first.)
+
+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,
+ use `<TMPL_IF NAME="variable">text<TMPL_ELSE>other text</TMPL_IF>`
+
+Here's a sample template:
+
+ <span class="infobox">
+ Name: \[[<TMPL_VAR raw_name>]]<br />
+ Age: <TMPL_VAR age><br />
+ <TMPL_IF NAME="color">
+ Favorite color: <TMPL_VAR color><br />
+ <TMPL_ELSE>
+ No favorite color.<br />
+ </TMPL_IF>
+ <TMPL_IF NAME="notes">
+ <hr />
+ <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.
+
+Note the use of "raw_name" inside the [[ikiwiki/WikiLink]] generator in the
+example above. 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]].
+
[[!meta robots="noindex, follow"]]
diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 07531ae98..f2b581d2f 100644
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -9,85 +9,9 @@ wiki.
[[!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 use with the template directive.
[[!inline pages="templates/* and !*/discussion" feeds=no archive=yes
-sort=title template=titlepage]]
+sort=title template=titlepage
+rootpage=templates postformtext="Add a new template named:"]]
"""]]
-
-## Using a template
-
-Using a template works like this:
-
- \[[!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.
-
-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:
-
- \[[!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.
- """]]
-
-## Creating a template
-
-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.
-
-(Alternatively, templates can be stored in a directory outside the wiki,
-as files with the extension ".tmpl".
-By default, these are searched for in `/usr/share/ikiwiki/templates`;
-the `templatedir` setting can be used to make another directory be searched
-first.)
-
-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,
- use `<TMPL_IF NAME="variable">text<TMPL_ELSE>other text</TMPL_IF>`
-
-Here's a sample template:
-
- <span class="infobox">
- Name: \[[<TMPL_VAR raw_name>]]<br />
- Age: <TMPL_VAR age><br />
- <TMPL_IF NAME="color">
- Favorite color: <TMPL_VAR color><br />
- <TMPL_ELSE>
- No favorite color.<br />
- </TMPL_IF>
- <TMPL_IF NAME="notes">
- <hr />
- <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.
-
-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]].