(no commit message)

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

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index d7480ee8f6371f8863dbc000a1e84f84a4952a3a..d189fa073468dce570508c2d5fefa2c6b5c0afb6 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -1,10 +1,5 @@
 [[Ikiwiki]] uses many templates for many purposes. By editing its templates,
 [[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.
+you can fully customise its appearance, and avoid duplicate content.

 
 Ikiwiki uses the HTML::Template module as its template engine. This
 supports things like conditionals and loops in templates and is pretty
 
 Ikiwiki uses the HTML::Template module as its template engine. This
 supports things like conditionals and loops in templates and is pretty


@@ -16,37 +11,52 @@ easy to learn. All you really need to know to modify templates is this:
 * 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>`
 
 * 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="""
+[[!if test="enabled(template) or enabled(edittemplate)" then="""

 ## template pages
 
 ## template pages
 

-The template directive allows wiki pages to be used as templates,
-filled out and inserted into other pages in the wiki.
+Template pages are regular wiki pages that are used as templates for other
+pages.

 """]]
 
 """]]
 

-[[!if test="enabled(edittemplate)" then="""
-## default content for new pages
+[[!if test="enabled(template)" then="""
+The [[!iki ikiwiki/directive/template desc="template directive"]] allows
+template pages to be filled out and inserted into other pages in the wiki.
+"""]]

 
 

-The edittemplate directive can be used to make new pages default to
-containing text from a template page, which can be filled as out the page is
-edited.
+[[!if test="enabled(edittemplate)" then="""
+The [[!iki ikiwiki/directive/edittemplate desc="edittemplate directive"]] can
+be used to make new pages default to containing text from a template
+page, which can be filled out as the page is edited.

 """]]
 
 """]]
 

-[[!if test="(enabled(template) or enabled(edittemplate)
+[[!if test="(enabled(template) or enabled(edittemplate))

 and enabled(inline)" then="""
 and enabled(inline)" then="""

+These template pages are currently available:
+

 [[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion"
 feeds=no archive=yes sort=title template=titlepage
 [[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion"
 feeds=no archive=yes sort=title template=titlepage

-rootpage=templates postformtext="Add a new template named:"]]
+rootpage=templates postformtext="Add a new template page named:"]]

 """]]
 
 """]]
 

-## wiki templates
+## template files
+
+Template files are unlike template pages in that they have the extension
+`.tmpl`. Template files are used extensively by Ikiwiki to generate html.
+They can contain html that would not normally be allowed on a wiki page.
+
+Template files are located in `/usr/share/ikiwiki/templates` by default;
+the `templatedir` setting can be used to make another directory be
+searched first. Customised template files can also be placed inside the
+"templates/" directory in your wiki's source -- files placed there override
+ones in the `templatedir`.

 
 

-These templates are used to build the wiki. The aim is to keep almost all
-html out of ikiwiki and in the templates.
+Here is a full list of the template files used:

 
 * `page.tmpl` - Used for displaying all regular wiki pages. This is the
 
 * `page.tmpl` - Used for displaying all regular wiki pages. This is the

-  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`.)"""]]
+  key template to customise to change the look and feel of Ikiwiki.
+  [[!if test="enabled(pagetemplate)" then="""
+  (The [[!iki ikiwiki/directive/pagetemplate desc="pagetemplate directive"]]
+  can be used to make a page use a 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.
 * `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.


@@ -55,7 +65,7 @@ html out of ikiwiki and in the templates.
 * `archivepage.tmpl` - Used for listing a page in a blog archive page.
 * `titlepage.tmpl` - Used for listing a page by title in a blog archive page.
 * `microblog.tmpl` - Used for showing a microblogging post inline.
 * `archivepage.tmpl` - Used for listing a page in a blog archive page.
 * `titlepage.tmpl` - Used for listing a page by title in a blog archive page.
 * `microblog.tmpl` - Used for showing a microblogging post inline.

-* `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links)
+* `blogpost.tmpl` - Used for a form to add a post to a blog (and rss/atom links)

 * `feedlink.tmpl` - Used to add rss/atom links if `blogpost.tmpl` is not used.
 * `aggregatepost.tmpl` - Used by the aggregate plugin to create
   a page for a post.
 * `feedlink.tmpl` - Used to add rss/atom links if `blogpost.tmpl` is not used.
 * `aggregatepost.tmpl` - Used by the aggregate plugin to create
   a page for a post.


@@ -73,7 +83,7 @@ html out of ikiwiki and in the templates.
 * `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
   `editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
   `editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,
 * `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
   `editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
   `editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,

-  `passwordmail.tmpl`, `openid-selector.tmpl` - Parts of ikiwiki's user
+  `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user

   interface; do not normally need to be customised.
 
 [[!meta robots="noindex, follow"]]
   interface; do not normally need to be customised.
 
 [[!meta robots="noindex, follow"]]