X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/4b55fcf3774218d7681747c701a9cbd8d620b025..6a7bd65b9b2f58f636204d49e9cc08ca2683c69b:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 7d606eaa9..870b3c451 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -181,7 +181,7 @@ source files that were rendered. Use this to hook into ikiwiki's cgi script. Each registered cgi hook is called in turn, and passed a CGI object. The hook should examine the -parameters, and if it will handle this CGI request, output a page and +parameters, and if it will handle this CGI request, output a page (including the http headers) and terminate the program. ### auth @@ -389,7 +389,7 @@ A failure to write the file will result in it dying with an error. If the destination directory doesn't exist, it will first be created. -### `will_render($$)` +#### `will_render($$)` Given a page name and a destination file name (not including the base destination directory), register that the page will result in that file @@ -422,7 +422,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($$)`