X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/074257f70228e7430c620d73ca2960fe860a00c6..40d739cabadf0686fd6b6fb887540fc50cec6669:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 6b9fc0218..10f715d9d 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -2,29 +2,37 @@ 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. -I aim to keep almost all html out of ikiwiki and in the templates. +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: -* `templates/page.tmpl` - Used for displaying all regular wiki pages. -* `templates/misc.tmpl` - Generic template used for any page that doesn't +* `page.tmpl` - Used for displaying all regular wiki pages. +* `misc.tmpl` - Generic template used for any page that doesn't have a custom template. -* `templates/recentchanges.tmpl` - Used for the RecentChanges page. -* `templates/editpage.tmpl` - Create/edit page. -* `templates/passwordmail.tmpl` - Not a html template, this is used to +* `recentchanges.tmpl` - Used for the RecentChanges 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. +* `passwordmail.tmpl` - Not a html template, this is used to generate the mail with the user's password in it. -* `templates/rsspage.tmpl` - Used for generating rss feeds for [[blog]]s. -* `templates/inlinepage.tmpl` - Used for adding a page inline in a blog +* `rsspage.tmpl` - Used for generating rss feeds for [[blog]]s. +* `inlinepage.tmpl` - Used for adding a page inline in a blog page. -* `templates/inlinepagetitle.tmpl` - Used for listing a page inline in a blog +* `inlinepagetitle.tmpl` - Used for listing a page inline 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. If you like, you can add these to further customise it: -* `templates/signin.tmpl` - If it exists, it is used for customising the +* `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. -* `templates/prefs.tmpl` - If it exists, it is used for customising the +* `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.