* Add a templates page to the basewiki. It will automatically list all
[ikiwiki.git] / doc / wikitemplates.mdwn
1 ikiwiki uses the HTML::Template module as its template engine. This
2 supports things like conditionals and loops in templates and is pretty easy
3 to learn.
4
5 The aim is to keep almost all html out of ikiwiki and in the templates.
6
7 It ships with some basic templates which can be customised. These are
8 located in /usr/share/ikiwiki/templates by default.
9
10 * `page.tmpl` - Used for displaying all regular wiki pages.
11 * `misc.tmpl` - Generic template used for any page that doesn't
12   have a custom template.
13 * `recentchanges.tmpl` - Used for the RecentChanges page.
14 * `editpage.tmpl` - Create/edit page.
15 * `notifymail.tmpl` - Not a html template, this is used to
16   generate change notification mails for users who have subscribed to
17   changes to a page.
18 * `passwordmail.tmpl` - Not a html template, this is used to
19   generate the mail with the user's password in it.
20 * `rsspage.tmpl` - Used for generating rss feeds for [[blog]]s.
21 * `rssitem.tmpl` - Used for generating individual items on rss feeds.
22 * `atompage.tmpl` - Used for generating atom feeds for [[blog]]s.
23 * `atomitem.tmpl` - Used for generating individual items on atom feeds.
24 * `inlinepage.tmpl` - Used for adding a page inline in a blog
25   page.
26 * `archivepage.tmpl` - Used for listing a page in a blog archive page.
27 * `estseek.conf` - Not a html template, this is actually a template for
28   a config file for the [[HyperEstraier]] search engine. If you like you
29   can read the [[HyperEstraier]] docs and configure it using this.
30 * `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links)
31 * `feedlink.tmpl` - Used to add rss/atom links if blogpost.tmpl is not used.
32 * `aggregatepost.tmpl` - Used by the [[plugins/aggregate]] plugin to create
33   a page for a post.
34 * `searchform.tmpl` - Used by the [[plugins/search]] plugin to add a search
35   form to wiki pages.
36
37 If you like, you can add these to further customise it:
38
39 * `signin.tmpl` - If it exists, it is used for customising the
40   layout of the SignIn form and all assciated forms. The misc.tmpl is
41   wrapped around this, so it should only be a template for the form.
42 * `prefs.tmpl` - If it exists, it is used for customising the
43   layout of the Prefs form and all assciated forms. The misc.tmpl is
44   wrapped around this, so it should only be a template for the form.
45   
46 Note that the SignIn and Prefs forms are implemented using
47 CGI::FormBuilder, which interfaces to HTML::Template, so not all of it can
48 be customised with templates, although most of it can, by creating these
49 templates. Without the templates, CGI::FormBuilder creates the page bodies
50 by itself.
51
52 The [[plugins/template]] plugin also uses templates, though those templates
53 are stored in the wiki.