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 * `editpage.tmpl` - Create/edit page.
  14 * `notifymail.tmpl` - Not a html template, this is used to
  15   generate change notification mails for users who have subscribed to
  16   changes to a page.
  17 * `recentchanges.tmpl` - Used to generate a RecentChanges table with inline.
  18 * `change.tmpl` - Used to create a page describing a change made to the wiki.
  19 * `passwordmail.tmpl` - Not a html template, this is used to
  20   generate the mail with the user's password in it.
  21 * `rsspage.tmpl` - Used for generating rss feeds for [blogs|[ikiwiki/blog]].
  22 * `rssitem.tmpl` - Used for generating individual items on rss feeds.
  23 * `atompage.tmpl` - Used for generating atom feeds for blogs.
  24 * `atomitem.tmpl` - Used for generating individual items on atom feeds.
  25 * `inlinepage.tmpl` - Used for adding a page inline in a blog
  26   page.
  27 * `archivepage.tmpl` - Used for listing a page in a blog archive page.
  28 * `estseek.conf` - Not a html template, this is actually a template for
  29   a config file for the [[HyperEstraier]] search engine. If you like you
  30   can read the [[HyperEstraier]] docs and configure it using this.
  31 * `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links)
  32 * `feedlink.tmpl` - Used to add rss/atom links if blogpost.tmpl is not used.
  33 * `aggregatepost.tmpl` - Used by the [[plugins/aggregate]] plugin to create
  34   a page for a post.
  35 * `searchform.tmpl` - Used by the [[plugins/search]] plugin to add a search
  36   form to wiki pages.
  37
  38 The [[plugins/pagetemplate]] plugin can allow individual pages to use a
  39 different template than `page.tmpl`.
  40
  41 The [[plugins/template]] plugin also uses templates, though those
  42 [[templates]] are stored in the wiki and inserted into pages.
  43
  44 The [[plugins/edittemplate]] plugin is used to make new pages default to
  45 containing text from a template, which can be filled as out the page is
  46 edited.