clean up

[git.ikiwiki.info.git] / doc / ikiwiki / directive / edittemplate.mdwn

diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn
index 779c3fa3c9ef8c6f496d1ae5ca9003195636eddf..569c2818f01835fcbacb24e5d873059c990a8ed4 100644 (file)
--- a/doc/ikiwiki/directive/edittemplate.mdwn
+++ b/doc/ikiwiki/directive/edittemplate.mdwn
@@ -2,12 +2,20 @@ The `edittemplate` directive is supplied by the [[!iki plugins/edittemplate desc
 
 This directive allows registering template pages, that provide default
 content for new pages created using the web frontend. To register a
 
 This directive allows registering template pages, that provide default
 content for new pages created using the web frontend. To register a

-template, insert a [[ikiwiki/directive/template]] directive on some other page.
+template, insert a [[ikiwiki/directive/template]] directive on some other
+page.

 
        \[[!edittemplate template="bugtemplate" match="bugs/*"]]
 
        \[[!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
 
 In the above example, the page named "bugtemplate" is registered as a

-template to be used when any page named "bugs/*" is created.
+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
 
 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


@@ -19,16 +27,8 @@ something like:
        Details:
 
 The template page can also contain [[!cpan HTML::Template]] directives,
        Details:
 
 The template page can also contain [[!cpan HTML::Template]] directives,

-similar to other ikiwiki [[templates]]. Currently only one variable is
+like other ikiwiki [[templates]]. Currently only one variable is

 set: `<TMPL_VAR name>` is replaced with the name of the page being
 created.
 
 set: `<TMPL_VAR name>` is replaced with the name of the page being
 created.
 

-----
-
-It's generally not a good idea to put the `edittemplate` directive in
-the template page itself, since the directive would then be included as
-part of the template on new pages, which would then in turn be registered
-as templates. If multiple pages are registered as templates for a new page,
-an arbitrary one is chosen, so that could get confusing.
-

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