X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/24359d670d8572630f5a447b8f46e955c1fb3fa4..ea588b7b2a4c22ea7f2e7daaba01891f48d0894c:/doc/templates.mdwn diff --git a/doc/templates.mdwn b/doc/templates.mdwn index a0a7f44c7..9ed9b838d 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,51 +1,83 @@ -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. - -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: - -* `page.tmpl` - Used for displaying all regular wiki pages. -* `misc.tmpl` - Generic template used for any page that doesn't - have a custom template. -* `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. -* `rsspage.tmpl` - Used for generating rss feeds for [[blog]]s. -* `rssitem.tmpl` - Used for generating individual items on rss feeds. -* `inlinepage.tmpl` - Used for adding a page inline in a blog - page. -* `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. -* `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: - -* `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. -* `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. - -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. - -The [[plugins/template]] plugin also uses templates, though those templates -are stored in the wiki. +[[if test="enabled(template)" +then="This wiki has templates **enabled**." +else="This wiki has templates **disabled**." +]] + +Templates are files that can be filled out and inserted into pages in the +wiki. + +[[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]] +"""]] + +## Using a template + +Using a template works like this: + + \[[template id=note text="""Here is the text to insert into my note."""]] + +This fills out the [[note]] template, filling in the `text` field with +the specified value, and inserts the result into the page. + +Generally, 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: + + \[[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. + """]] + +## Creating a template + +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. + +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: + +* To insert the value of a variable, use ``. Wiki markup + in the value will first be converted to html. +* To insert the raw value of a variable, with wiki markup not yet converted + to html, 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. + +Note the use of "raw_name" inside the [[WikiLink]] generator. This ensures +that if the name contains something that might be mistaken for wiki markup, +it's not converted to html before being processed as a [[WikiLink]].