X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9921a4a8a1a696ce69acce5e14943f0149d926ff..decb7051f6436aedfd0e9de934d149d9c5b22b36:/doc/ikiwiki/directive/edittemplate.mdwn diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn index b3187ea66..a6f301dd3 100644 --- a/doc/ikiwiki/directive/edittemplate.mdwn +++ b/doc/ikiwiki/directive/edittemplate.mdwn @@ -1,13 +1,21 @@ -The `edittemplate` directive is supplied by the [[!iki plugins/edittemplate]] plugin. +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 a [[ikiwiki/directive/template]] directive on some other page. +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. +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 @@ -19,16 +27,8 @@ something like: 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: `` 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"]]