]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/templates.mdwn
another issue with the mercurual backend
[ikiwiki.git] / doc / templates.mdwn
index 10f715d9d4f30b0ab5f601da6e949b2ad2755823..1f98334c9ff32d8c090b4e3f933bfbd0eca5798e 100644 (file)
@@ -4,7 +4,8 @@ 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:
+It ships with some basic templates which can be customised. These are
+located in /usr/share/ikiwiki/templates by default.
 
 * `page.tmpl` - Used for displaying all regular wiki pages.
 * `misc.tmpl` - Generic template used for any page that doesn't
@@ -17,15 +18,21 @@ It ships with some basic templates which can be customised:
 * `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.
+* `rssitem.tmpl` - Used for generating individual items on rss feeds.
+* `atompage.tmpl` - Used for generating atom feeds for [[blog]]s.
+* `atomitem.tmpl` - Used for generating individual items on atom feeds.
 * `inlinepage.tmpl` - Used for adding a page inline in a blog
   page.
-* `inlinepagetitle.tmpl` - Used for listing a page inline in a blog
-  archive 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.
-* `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss link)
-* `rsslink.tmpl` - Used to add a rss link if blogpost.tmpl is not used.
+* `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.
 
 If you like, you can add these to further customise it:
 
@@ -41,3 +48,6 @@ CGI::FormBuilder, which interfaces to HTML::Template, so not all of it can
 be customised with templates, although most of it can, by creating these
 templates. Without the templates, CGI::FormBuilder creates the page bodies
 by itself.
+
+The [[plugins/template]] plugin also uses templates, though those templates
+are stored in the wiki.