X-Git-Url: https://scripts.mit.edu/gitweb/www/ikiwiki.git/blobdiff_plain/c46b17983dc5549172dabb461b72a4ed11f110ae..3b9fe3a1b64b011a72b6c54cb172a27922250d8b:/doc/plugins/edittemplate.mdwn diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn index 6963b7125..a68f7f0a1 100644 --- a/doc/plugins/edittemplate.mdwn +++ b/doc/plugins/edittemplate.mdwn @@ -1,25 +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 [[Preprocessor_Directive|/ikiwiki/preprocessordirective]] on some other page. -[[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. -"""]] - - \[[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. ----- - 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: @@ -29,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.