X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/dae0f48e91304afcb6ebe0936360e51b22a56548..c9a652b311dabaf8b30ad455d7fcdf29c79a98b0:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 8886bca29..57521687e 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -105,13 +105,13 @@ return the htmlized content. hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); -Each time a page (or part of a blog page, or an rss feed) is rendered, a -[[template|templates]] is filled out. This hook allows modifying that -template. The function is passed named parameters. The "page" and -"destpage" parameters are the same as for a preprocess hook. The "template" -parameter is a `HTML::Template` object that is the template that will be -used to generate the page. The function can manipulate that template -object. +[[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 `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. @@ -173,7 +173,7 @@ they're saved, etc. To import the ikiwiki plugin interface: - use IkiWiki; + use IkiWiki '1.00'; This will import several variables and functions into your plugin's namespace. These variables and functions are the ones most plugins need,