web commit by MarkusSchaber

[git.ikiwiki.info.git] / doc / templates.mdwn

diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 97a91d28bb667a234611b402aee97585b67e980e..1f98334c9ff32d8c090b4e3f933bfbd0eca5798e 100644 (file)
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -4,33 +4,42 @@ to learn.
 
 The aim is 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:
+It ships with some basic templates which can be customised. These are
+located in /usr/share/ikiwiki/templates by default.

 
 

-* `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.
   have a custom template.

-* `templates/recentchanges.tmpl` - Used for the RecentChanges page.
-* `templates/editpage.tmpl` - Create/edit page.
-* `templates/notifymail.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.
   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
+* `passwordmail.tmpl` - Not a html template, this is used to

   generate the mail with the user's password in it.
   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.
+* `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.
   page.

-* `templates/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.
 * `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/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:
 
 
 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.
   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.
   
   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.
   


@@ -39,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.
 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.