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