]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/edittemplate.mdwn
patch plugin documentation to refer to directive pages
[ikiwiki.git] / doc / plugins / edittemplate.mdwn
index 798d1290c12d85992dad5f826381292400565cbb..646fc9af7117f010ce38e096cf35066ba377cb19 100644 (file)
@@ -1,33 +1,6 @@
-[[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 [[Preprocessor Directive|/ikiwiki/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.
-
-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: `<TMPL_VAR name>` 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.
+This plugin implements the [[ikiwiki/directive/edittemplate]] [[ikiwiki/directive]].
+This directive allows registering template pages, that provide default
+content for new pages created using the web frontend.