move template documentation to the template directive

[ikiwiki.git] / doc / wikitemplates.mdwn

diff --git a/doc/wikitemplates.mdwn b/doc/wikitemplates.mdwn
index 5e2eb8a3769a392371f51b27dd4af1b65a34cfdd..6e5a7261daaf2d6ef7cd1be919e1e315232d9674 100644 (file)
--- a/doc/wikitemplates.mdwn
+++ b/doc/wikitemplates.mdwn
@@ -5,34 +5,48 @@ to learn.
 The aim is to keep almost all html out of ikiwiki and in the templates.
 
 It ships with some basic templates which can be customised. These are
 The aim is to keep almost all html out of ikiwiki and in the templates.
 
 It ships with some basic templates which can be customised. These are

-located in /usr/share/ikiwiki/templates by default.
+located in `/usr/share/ikiwiki/templates` by default; the `templatedir`
+setting can be used to make another directory be searched first.

 
 * `page.tmpl` - Used for displaying all regular wiki pages.
 * `misc.tmpl` - Generic template used for any page that doesn't
   have a custom template.
 
 * `page.tmpl` - Used for displaying all regular wiki pages.
 * `misc.tmpl` - Generic template used for any page that doesn't
   have a custom template.

-* `recentchanges.tmpl` - Used for the RecentChanges page.

 * `editpage.tmpl` - Create/edit page.
 * `editpage.tmpl` - Create/edit page.

-* `notifymail.tmpl` - Not a html template, this is used to
-  generate change notification mails for users who have subscribed to
-  changes to a page.
+* `change.tmpl` - Used to create a page describing a change made to the wiki.

 * `passwordmail.tmpl` - Not a html template, this is used to
 * `passwordmail.tmpl` - Not a html template, this is used to

-  generate the mail with the user's password in it.
-* `rsspage.tmpl` - Used for generating rss feeds for [[blog]]s.
+  generate a mail with an url the user can use to reset their password.
+* `rsspage.tmpl` - Used for generating rss feeds for [[blogs|blog]].

 * `rssitem.tmpl` - Used for generating individual items on rss feeds.
 * `rssitem.tmpl` - Used for generating individual items on rss feeds.

-* `atompage.tmpl` - Used for generating atom feeds for [[blog]]s.
+* `atompage.tmpl` - Used for generating atom feeds for blogs.

 * `atomitem.tmpl` - Used for generating individual items on atom feeds.
 * `inlinepage.tmpl` - Used for adding a page inline in a blog
   page.
 * `archivepage.tmpl` - Used for listing a page in a blog archive page.
 * `atomitem.tmpl` - Used for generating individual items on atom feeds.
 * `inlinepage.tmpl` - Used for adding a page inline in a blog
   page.
 * `archivepage.tmpl` - Used for listing a page in a blog archive page.

-* `estseek.conf` - Not a html template, this is actually a template for
-  a config file for the [[HyperEstraier]] search engine. If you like you
-  can read the [[HyperEstraier]] docs and configure it using this.
+* `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)
 * `feedlink.tmpl` - Used to add rss/atom links if blogpost.tmpl is not used.
 * `aggregatepost.tmpl` - Used by the [[plugins/aggregate]] plugin to create
   a page for a post.
 * `searchform.tmpl` - Used by the [[plugins/search]] plugin to add a search
   form to wiki pages.
 * `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links)
 * `feedlink.tmpl` - Used to add rss/atom links if blogpost.tmpl is not used.
 * `aggregatepost.tmpl` - Used by the [[plugins/aggregate]] plugin to create
   a page for a post.
 * `searchform.tmpl` - Used by the [[plugins/search]] plugin to add a search
   form to wiki pages.

+* `searchquery.tmpl` - This is an omega template, used by the
+  [[plugins/search]] plugin.
+* `comment.tmpl` - This template is used to display a comment
+  by the [[plugins/comments]] plugin.
+* `editcomment.tmpl` - This template is the comment post form for the
+  [[plugins/comments]] plugin.
+* `commentmoderation.tmpl` - This template is used to produce the comment
+  moderation form.
+* `recentchanges.tmpl` - This template is used for listing a change
+  on the RecentChanges page.
+
+The [[plugins/pagetemplate]] plugin can allow individual pages to use a
+different template than `page.tmpl`.

 
 The [[plugins/template]] plugin also uses templates, though those
 
 The [[plugins/template]] plugin also uses templates, though those

-[[templates]] are stored in the wiki.
+[[templates]] are typically stored as pages in the wiki, and are inserted
+into pages.
+
+The [[plugins/edittemplate]] plugin is used to make new pages default to
+containing text from a template, which can be filled as out the page is
+edited.