bugfixes

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

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 0e54ae8a0840a4cdfd85bf889dae8c77a80a9671..8f6561fcf3fff334dacbf928006bd8d75b8d75be 100644 (file)
--- 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 to modify templates is this:
+
+* 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 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 variable>text<TMPL_ELSE>other text</TMPL_IF>`
+
 [[!if test="enabled(template)" then="""
 ## template pages
 
@@ -8,16 +23,10 @@ The template directive allows wiki pages to be used as templates,
 filled out and inserted into other pages in the wiki.
 """]]
 [[!if test="enabled(template) and enabled(inline)" then="""
-[[!inline pages="templates/* and !*/discussion" feeds=no archive=yes
-sort=title template=titlepage
+[[!inline pages="templates/* and !*.tmpl and !*/discussion"
+feeds=no archive=yes 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,13 +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`.)
-"""]]
-* `misc.tmpl` - Generic template used for any page that doesn't
-  have a custom template.
+  different template than `page.tmpl`.)"""]]
 * `rsspage.tmpl` - Used for generating rss feeds for blogs.
 * `rssitem.tmpl` - Used for generating individual items on rss feeds.
 * `atompage.tmpl` - Used for generating atom feeds for blogs.
@@ -69,23 +74,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"]]