ikiwiki/doc/templates.mdwn

42 lines
2.0 KiB
Plaintext
Raw Normal View History

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.
2006-03-12 05:09:59 +01:00
2006-03-21 03:38:17 +01:00
I aim to keep almost all html out of ikiwiki and in the templates.
2006-03-12 05:09:59 +01:00
It ships with some basic templates which can be customised:
* `templates/page.tmpl` - Used for displaying all regular wiki pages.
* `templates/misc.tmpl` - Generic template used for any page that doesn't
have a custom template.
2006-03-12 05:09:59 +01:00
* `templates/recentchanges.tmpl` - Used for the RecentChanges page.
* `templates/editpage.tmpl` - Create/edit page.
2006-04-25 02:27:00 +02:00
* `templates/notifymail.tmpl` - Not a html template, this is used to
generate change notification mails for users who have subscribed to
changes to a page.
* `templates/passwordmail.tmpl` - Not a html template, this is used to
generate the mail with the user's password in it.
2006-03-24 02:49:42 +01:00
* `templates/rsspage.tmpl` - Used for generating rss feeds for [[blog]]s.
2006-03-24 11:52:04 +01:00
* `templates/inlinepage.tmpl` - Used for adding a page inline in a blog
2006-03-24 02:49:42 +01:00
page.
2006-03-24 11:52:04 +01:00
* `templates/inlinepagetitle.tmpl` - Used for listing a page inline in a blog
2006-03-24 02:49:42 +01:00
archive page.
2006-03-30 00:36:23 +02:00
* `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.
2006-03-21 03:38:17 +01:00
If you like, you can add these to further customise it:
* `templates/signin.tmpl` - If it exists, it is used for customising the
layout of the SignIn form and all assciated forms. The misc.tmpl is
wrapped around this, so it should only be a template for the form.
2006-03-21 03:38:17 +01:00
* `templates/prefs.tmpl` - If it exists, it is used for customising the
layout of the Prefs form and all assciated forms. The misc.tmpl is
wrapped around this, so it should only be a template for the form.
2006-03-21 03:38:17 +01:00
Note that the SignIn and Prefs forms are implemented using
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.