works, but I'm not entirely happy with it yet
[ikiwiki.git] / doc / plugins / edittemplate.mdwn
1 [[template id=plugin name=edittemplate author="[[Joey]]"]]
2 [[tag type/useful]]
3
4 This plugin allows registering template pages, that provide default
5 content for new pages created using the web frontend. To register a
6 template, insert a [[PreprocessorDirective]] on some other page.
7
8 [[template id=note text="""
9 Note: It's generally not a good idea to put the `edittemplate` directive in
10 the template page itself, since the directive would then be included as
11 part of the template on new pages, which would then in turn be registered
12 as templates. If multiple pages are registered as templates for a new page,
13 an arbitrary one is chosen, so that could get confusing.
14 """]]
15
16         \[[edittemplate template="bugtemplate" match="bugs/*"]]
17
18 In the above example, the page named "bugtemplate" is registered as a
19 template to be used when any page named "bugs/*" is created.
20
21 ----
22
23 Often the template page contains a simple skeleton for a particular type of
24 page. For the bug report pages in the above example, it might look
25 something like:
26
27         Package: 
28         Version: 
29         Reproducible: y/n
30         Details:
31
32 The template page can also contain [[cpan HTML::Template]] directives,
33 similar to other ikiwiki [[templates]]. Currently only one variable is
34 set: `<TMPL_VAR name>` is replaced with the name of the page being
35 created.