aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2016-08-22 18:07:33 +0100
committerSimon McVittie <smcv@debian.org>2016-08-22 18:08:03 +0100
commitc2eb4ee602d142d958b1337505d67293c04ce2e2 (patch)
tree5f771350d9be8d9237fb9875f35caa82695002c3 /doc/ikiwiki
parent14f265d69dd4f3743ec11b26ff0ee84309950466 (diff)
downloadikiwiki-c2eb4ee602d142d958b1337505d67293c04ce2e2.tar
ikiwiki-c2eb4ee602d142d958b1337505d67293c04ce2e2.tar.gz
Revert spam. Consider yourself banned.
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r--doc/ikiwiki/directive/edittemplate.mdwn54
-rw-r--r--doc/ikiwiki/directive/edittemplate/discussion.mdwn2
-rw-r--r--doc/ikiwiki/directive/templatebody.mdwn6
3 files changed, 59 insertions, 3 deletions
diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn
new file mode 100644
index 000000000..70bd2ad25
--- /dev/null
+++ b/doc/ikiwiki/directive/edittemplate.mdwn
@@ -0,0 +1,54 @@
+The `edittemplate` directive is supplied by the [[!iki plugins/edittemplate desc=edittemplate]] plugin.
+
+This directive allows registering template pages, that provide default
+content for new pages created using the web frontend. To register a
+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
+the directive displaying a note about the template being registered, add
+"silent=yes".
+
+Often the template page contains a simple skeleton for a particular type of
+page, wrapped in a [[templatebody]] directive. For the bug report pages in
+the above example, it might look something like:
+
+ \[[!templatebody <<ENDBODY
+ Package:
+ Version:
+ Reproducible: y/n
+ Details:
+ ENDBODY]]
+
+The template page can also contain [[!cpan HTML::Template]] directives,
+like other ikiwiki [[templates]].
+
+These variables might be set:
+
+* `<TMPL_VAR name>` is replaced with the name of the page being
+ created.
+
+* `<TMPL_VAR uuid>` is replaced with a version 4 (random) UUID
+ suitable for use in `\[[!meta guid="urn:uuid:<TMPL_VAR uuid>"]]`.
+ (Requires the `UUID::Tiny` Perl module if not running on Linux.)
+
+* `<TMPL_VAR time>` is replaced with the current (template generation)
+ time using a fixed format (RFC 3339, `%Y-%m-%dT%H:%M:%SZ`),
+ suitable for use in `\[[!meta date="<TMPL_VAR time>"]]`
+ (see [[meta]]) or `\[[!date "<TMPL_VAR time>"]]` (see [[date]]).
+
+Text outside the [[templatebody]] directive is not part of the template,
+and can be used to document it.
+
+If the template does not contain a [[templatebody]] directive, the entire
+source of the page is used for the template. This is deprecated.
+
+[[!meta robots="noindex, follow"]]
diff --git a/doc/ikiwiki/directive/edittemplate/discussion.mdwn b/doc/ikiwiki/directive/edittemplate/discussion.mdwn
new file mode 100644
index 000000000..81db204d4
--- /dev/null
+++ b/doc/ikiwiki/directive/edittemplate/discussion.mdwn
@@ -0,0 +1,2 @@
+For some years now I do feel quite comfortable when using all things *template. But one thing I stumble across when setting up another ikiwiki driven site is a sort of misleading resp. missing description with the [[edittemplate]] directive, where it says "(Don't put the directive on the template page itself)". While this is right there should also be mentioned that "the page holding the edittemplage directive must not be named the same as the template page it refers to". At least with my usual setup the edittemplate directive will not work whenever I attempt to simplify things by giving it the same name as the template page.
+Boris
diff --git a/doc/ikiwiki/directive/templatebody.mdwn b/doc/ikiwiki/directive/templatebody.mdwn
index 68b49bdf3..36b5af172 100644
--- a/doc/ikiwiki/directive/templatebody.mdwn
+++ b/doc/ikiwiki/directive/templatebody.mdwn
@@ -1,8 +1,8 @@
-The `USA/UK/CANADA number +++++ 18557092847++++****** Epson Printer tech support customer sERVice number helpline number` directive is supplied by the
+The `templatebody` directive is supplied by the
[[!iki plugins/templatebody desc=templatebody]] plugin.
This directive allows wiki pages to be used as templates
-for the [[template]] or [[USA/UK/CANADA_number_+++++_18557092847++++******_Epson_Printer_tech_support_customer_sERVice_number_helpline_number]] directive, without having
+for the [[template]] or [[edittemplate]] directive, without having
[[!cpan HTML::Template]] markup interpreted as wiki markup when that
page is built.
@@ -14,7 +14,7 @@ The first, un-named parameter is the content of the template.
Because templates often contain [[directives|ikiwiki/directive]], it's
convenient to use the "here-document" syntax for it:
- \[[!USA/UK/CANADA number +++++ 18557092847++++****** Epson Printer tech support customer sERVice number helpline number <<ENDBODY
+ \[[!templatebody <<ENDBODY
[[!meta title="<TMPL_VAR name>"]]
\[[!tag person]]
<dl>