X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8576fe4c4913c2ebe678c54f9353ac22c6bdaa84..e8a23c299e0ec548110283516b8413cdaff8737e:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 0b0a61af2..f7b3adae5 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,76 +1,88 @@ -[[if test="enabled(template)" -then="This wiki has templates **enabled**." -else="This wiki has templates **disabled**." -]] +[[Ikiwiki]] uses many templates for many purposes. By editing its templates, +you can fully customise this site. -Templates are files that can be filled out and inserted into pages in the -wiki. +[[!if test="enabled(template)" then=""" +## The template directive -[[if test="enabled(template) and enabled(inline)" then=""" - -## Available templates - -These templates are available for inclusion onto other pages in this -wiki: - -[[inline pages="templates/* and !*/discussion" feeds=no archive=yes -sort=title template=titlepage]] +The template directive allows wiki pages to be used as templates. +These templates can be filled out and inserted into other pages in the +wiki using the directive. +"""]] +[[!if test="enabled(template) and enabled(inline)" then=""" +[[!inline pages="templates/* and !*/discussion" feeds=no archive=yes +sort=title template=titlepage +rootpage=templates postformtext="Add a new template named:"]] """]] -## Using a template - -Using a template works like this: - - \[[template id=note text="""Here is the text to insert into my note."""]] +[[!if test="enabled(edittemplate)" then=""" +## The edittemplate directive -This fills out the [[note]] template, filling in the `text` field with -the specified value, and inserts the result into the page. +The edittemplate directive can be used to make new pages default to +containing text from a template, which can be filled as out the page is +edited. +"""]] -A value can include any markup that would be allowed in the wiki page -outside the template. Triple-quoting the value even allows quotes to be -included in it. Combined with multi-line quoted values, this allows for -large chunks of marked up text to be embedded into a template: +## Wiki templates + +These templates are used to build the wiki. The aim is to keep almost all +html out of ikiwiki and in the templates. + +* `page.tmpl` - Used for displaying all regular wiki pages. +* `misc.tmpl` - Generic template used for any page that doesn't + have a custom template. +* `editpage.tmpl` - Create/edit page. +* `change.tmpl` - Used to create a page describing a change made to the wiki. +* `passwordmail.tmpl` - Not a html template, this is used to + generate a mail with an url the user can use to reset their password. +* `rsspage.tmpl` - Used for generating rss feeds for [[blogs|blog]]. +* `rssitem.tmpl` - Used for generating individual items on rss feeds. +* `atompage.tmpl` - Used for generating atom feeds for blogs. +* `atomitem.tmpl` - Used for generating individual items on atom feeds. +* `inlinepage.tmpl` - Used for adding a page inline in a blog + page. +* `archivepage.tmpl` - Used for listing a page in a blog archive page. +* `microblog.tmpl` - Used for showing a microblogging post inline. +* `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. +* `searchquery.tmpl` - This is an omega template, used by the + [[plugins/search]] plugin. +* `comment.tmpl` - This template is used to display a comment + by the [[plugins/comments]] plugin. +* `editcomment.tmpl` - This template is the comment post form for the + [[plugins/comments]] plugin. +* `commentmoderation.tmpl` - This template is used to produce the comment + moderation form. +* `recentchanges.tmpl` - This template is used for listing a change + on the RecentChanges page. + +[[!if test="enabled(pagetemplate)" then=""" +## The pagetemplate directive + +The pagetemplate directive can allow individual pages to use a +different template than `page.tmpl`. +"""]] - \[[template id=foo name="Sally" color="green" age=8 notes=""" - * \[[Charley]]'s sister. - * "I want to be an astronaut when I grow up." - * Really 8 and a half. - """]] +## Template locations -## Creating a template +Templates are located in `/usr/share/ikiwiki/templates` by default; +the `templatedir` setting can be used to make another directory be +searched first. Customized templates can also be placed inside the +"templates/" directory in your wiki's source. -To create a template, simply add a template directive to a page, and page will -provide a link that can be used to create the template. The template is a -regular wiki page, located in the `templates/` directory. +## Template syntax -The template uses the syntax used by the [[cpan HTML::Template]] perl -module, which allows for some fairly complex things to be done. Consult its -documentation for the full syntax, but all you really need to know are a -few things: +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. All you really need to know are a few things: -* To insert the value of a variable, use ``. +* To insert the value of a template variable, use ``. * To make a block of text conditional on a variable being set use `text`. * To use one block of text if a variable is set and a second if it's not, use `textother text` -Here's a sample template: - - - Name:
- Age:
- - Favorite color:
- - No favorite color.
- - -
- - - - -The filled out template will be formatted the same as the rest of the page -that contains it, so you can include WikiLinks and all other forms of wiki -markup in the template. Note though that such WikiLinks will not show up as -backlinks to the page that uses the template. +[[!meta robots="noindex, follow"]]