aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/edittemplate.mdwn
blob: a6f301dd3c5906548fcdfd3853dd33937abe96d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
The `edittemplate` directive is supplied by the [[!iki plugins/edittemplate desc=edittemplate]] plugin.

This directive allows registering template pages, that provide default
content for new pages created using the web frontend. To register a
template, insert an [[ikiwiki/directive/edittemplate]] directive on some other
page.

	\[[!edittemplate template="bugtemplate" match="bugs/*"]]
 
A recommended place to put the directive is on the parent page
of the pages that will be created using the template. So the above
example would be put on the bugs page. (Do not put the directive on the
template page itself.)

In the above example, the page named "bugtemplate" is registered as a
template to be used when any page named "bugs/*" is created. To avoid
the directive displaying a note about the template being registered, add
"silent=yes".

Often the template page contains a simple skeleton for a particular type of
page. For the bug report pages in the above example, it might look
something like:

	Package: 
	Version: 
	Reproducible: y/n
	Details:

The template page can also contain [[!cpan HTML::Template]] directives,
like other ikiwiki [[templates]]. Currently only one variable is
set: `<TMPL_VAR name>` is replaced with the name of the page being
created.

[[!meta robots="noindex, follow"]]