summaryrefslogtreecommitdiff
path: root/doc/plugins/pagetemplate.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/pagetemplate.mdwn')
-rw-r--r--doc/plugins/pagetemplate.mdwn16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/plugins/pagetemplate.mdwn b/doc/plugins/pagetemplate.mdwn
new file mode 100644
index 000000000..192322d72
--- /dev/null
+++ b/doc/plugins/pagetemplate.mdwn
@@ -0,0 +1,16 @@
+[[template id=plugin name=pagetemplate author="[[Joey]]"]]
+[[tag type/chrome]]
+
+This plugin allows a page to be created using a different
+[[template|wikitemplate]]. The page text is inserted into the template, so
+the template controls the overall look and feel of the wiki page. This is
+in contrast to the [[template]] plugin, which allows inserting templates
+_into_ the body of a page.
+
+This plugin can only use templates that are already installed in
+/usr/share/ikiwiki/templates (or wherever ikiwiki is configured to look for
+them). You can choose to use any .tmpl files in that directory. Example:
+
+ \[[pagetemplate template=my_fancy.tmpl]]
+
+[[pagetemplate template=my_fancy.tmpl]]