X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8576fe4c4913c2ebe678c54f9353ac22c6bdaa84..6a03860fb7e9db5cb3374e22d827571ddac0c40a:/doc/plugins/edittemplate.mdwn?ds=inline diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn index 6d889f5f1..674bdc863 100644 --- a/doc/plugins/edittemplate.mdwn +++ b/doc/plugins/edittemplate.mdwn @@ -1,23 +1,15 @@ -[[template id=plugin name=edittemplate author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=edittemplate author="[[Joey]]"]] +[[!tag type/useful]] This plugin allows registering template pages, that provide default content for new pages created using the web frontend. To register a -template, insert a [[PreprocessorDirective]] on some other page. +template, insert a [[ikiwiki/directive]] on some other page. - \[[edittemplate template="bugtemplate" match="bugs/*"]] + \[[!edittemplate template="bugtemplate" match="bugs/*"]] In the above example, the page named "bugtemplate" is registered as a template to be used when any page named "bugs/*" is created. -[[template id=note text=""" -Note: 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. -"""]] - 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: @@ -27,7 +19,15 @@ something like: Reproducible: y/n Details: -The template page can also contain [[cpan HTML::Template]] directives, +The template page can also contain [[!cpan HTML::Template]] directives, similar to 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.