From 8576fe4c4913c2ebe678c54f9353ac22c6bdaa84 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Wed, 12 Dec 2007 01:52:26 -0500 Subject: incomplate edittemplate plugin --- doc/plugins/edittemplate.mdwn | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 doc/plugins/edittemplate.mdwn (limited to 'doc/plugins') diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn new file mode 100644 index 000000000..6d889f5f1 --- /dev/null +++ b/doc/plugins/edittemplate.mdwn @@ -0,0 +1,33 @@ +[[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. + + \[[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: + + Package: + Version: + Reproducible: y/n + Details: + +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. -- cgit v1.2.3