diff options
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/pagetemplate.mdwn | 16 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 25 |
2 files changed, 34 insertions, 7 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]] diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 870b3c451..a122845af 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -128,17 +128,28 @@ return the htmlized content. hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); -[[Templates]] are filled out for many different things in ikiwiki, like -generating a page, or part of a blog page, or an rss feed, or a cgi. This -hook allows modifying those templates. The function is passed named -parameters. The "page" and "destpage" parameters are the same as for a -preprocess hook. The "template" parameter is a [[cpan HTML::Template]] -object that is the template that will be used to generate the page. The -function can manipulate that template object. +[[Templates|wikitemplate]] are filled out for many different things in +ikiwiki, like generating a page, or part of a blog page, or an rss feed, or +a cgi. This hook allows modifying the variables available on those +templates. The function is passed named parameters. The "page" and +"destpage" parameters are the same as for a preprocess hook. The "template" +parameter is a [[cpan HTML::Template]] object that is the template that +will be used to generate the page. The function can manipulate that +template object. The most common thing to do is probably to call `$template->param()` to add a new custom parameter to the template. +### templatefile + + hook(type => "templatefile", id => "foo", call => \&templatefile); + +This hook allows plugins to change the [[template|wikitemplate]] that is +used for a page in the wiki. The hook is passed a "page" parameter, and +should return the name of the template file to use, or undef if it doesn't +want to change the default ("page.tmpl"). Template files are looked for in +/usr/share/ikiwiki/templates by default. + ### sanitize hook(type => "sanitize", id => "foo", call => \&sanitize); |