aboutsummaryrefslogtreecommitdiff
path: root/doc/templates.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-04-24 01:36:01 -0400
committerJoey Hess <joey@kitenet.net>2010-04-24 01:39:39 -0400
commita95d824cb43b9ffadb802f0804818b329f57d69a (patch)
tree0fd3c13a2dedea15e498b169d90959d7563a64ae /doc/templates.mdwn
parentdf012e54c7bf5a8e8fb2cb3c2f8cbf8dc30686f9 (diff)
downloadikiwiki-a95d824cb43b9ffadb802f0804818b329f57d69a.tar
ikiwiki-a95d824cb43b9ffadb802f0804818b329f57d69a.tar.gz
update
Diffstat (limited to 'doc/templates.mdwn')
-rw-r--r--doc/templates.mdwn46
1 files changed, 17 insertions, 29 deletions
diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 0e54ae8a0..67e5517e4 100644
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -1,6 +1,21 @@
[[Ikiwiki]] uses many templates for many purposes. By editing its templates,
you can fully customise this site.
+Templates are located in `/usr/share/ikiwiki/templates` by default;
+the `templatedir` setting can be used to make another directory be
+searched first. Customized templates can also be placed inside the
+"templates/" directory in your wiki's source.
+
+Ikiwiki uses the HTML::Template module as its template engine. This
+supports things like conditionals and loops in templates and is pretty
+easy to learn. All you really need to know are a few things:
+
+* To insert the value of a template variable, use `<TMPL_VAR 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>`
+
[[!if test="enabled(template)" then="""
## template pages
@@ -12,12 +27,6 @@ filled out and inserted into other pages in the wiki.
sort=title template=titlepage
rootpage=templates postformtext="Add a new template named:"]]
"""]]
-[[!if test="enabled(template)" then="""
-[[!template id=note text="This note box is built using the
-[[note]] template!"]]
-[[!template id=popup mouseover="popup example" popup="This popup is built using
-the [[popup]] template!"]]
-"""]]
[[!if test="enabled(edittemplate)" then="""
## edit templates
@@ -33,11 +42,9 @@ These templates are used to build the wiki. The aim is to keep almost all
html out of ikiwiki and in the templates.
* `page.tmpl` - Used for displaying all regular wiki pages. This is the
- key template customize.
-[[!if test="enabled(pagetemplate)" then="""
+ key template to customize. [[!if test="enabled(pagetemplate)" then="""
(The pagetemplate directive can be used to make a page use a
- different template than `page.tmpl`.)
-"""]]
+ different template than `page.tmpl`.)"""]]
* `misc.tmpl` - Generic template used for any page that doesn't
have a custom template.
* `rsspage.tmpl` - Used for generating rss feeds for blogs.
@@ -69,23 +76,4 @@ html out of ikiwiki and in the templates.
`passwordmail.tmpl` - Parts of ikiwiki's user interface; do not
normally need to be customised.
-## Template locations
-
-Templates are located in `/usr/share/ikiwiki/templates` by default;
-the `templatedir` setting can be used to make another directory be
-searched first. Customized templates can also be placed inside the
-"templates/" directory in your wiki's source.
-
-## Template syntax
-
-Ikiwiki uses the HTML::Template module as its template engine. This
-supports things like conditionals and loops in templates and is pretty easy
-to learn. All you really need to know are a few things:
-
-* To insert the value of a template variable, use `<TMPL_VAR 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>`
-
[[!meta robots="noindex, follow"]]