summaryrefslogtreecommitdiff
path: root/doc/plugins/edittemplate.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:05:51 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:51 -0400
commitc69a7f758590c91bd137a8d1cfa99f37bf28045a (patch)
tree16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/edittemplate.mdwn
parent4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff)
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/edittemplate.mdwn')
-rw-r--r--doc/plugins/edittemplate.mdwn33
1 files changed, 3 insertions, 30 deletions
diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn
index 674bdc863..646fc9af7 100644
--- a/doc/plugins/edittemplate.mdwn
+++ b/doc/plugins/edittemplate.mdwn
@@ -1,33 +1,6 @@
[[!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 [[ikiwiki/directive]] 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.