X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/e8a23c299e0ec548110283516b8413cdaff8737e..eb87dd177ae5ad2838c9bb9acb5e1e40d9cc5f28:/doc/ikiwiki/directive/edittemplate.mdwn diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn index c486e821b..63df23914 100644 --- a/doc/ikiwiki/directive/edittemplate.mdwn +++ b/doc/ikiwiki/directive/edittemplate.mdwn @@ -2,9 +2,15 @@ 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 -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. To avoid @@ -21,16 +27,14 @@ something like: Details: The template page can also contain [[!cpan HTML::Template]] directives, -like other ikiwiki [[templates]]. Currently only one variable is -set: `` is replaced with the name of the page being -created. +like other ikiwiki [[templates]]. ----- +Two variables might be set: -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. +* `` is replaced with the name of the page being + created. + +* `` is replaced with a version 4 (random) UUID. + (Requires the `UUID::Tiny` Perl module if not running on Linux.) [[!meta robots="noindex, follow"]]