X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1fe10b61149821571bd74da712b381a63afeaee6..bad740b94387d4289d6267715e09c2bedf1f210b:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 8f0a99acb..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); @@ -422,7 +433,9 @@ This is the standard gettext function, although slightly optimised. #### `urlto($$)` -Construct a relative url to the first parameter from the second. +Construct a relative url to the first parameter from the page named by the +second. The first parameter can be either a page name, or some other +destination file, as registered by `will_render`. #### `targetpage($$)`