improve

[git.ikiwiki.info.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 7d606eaa924349469ab9adb63688ca602ba0a4ce..870b3c451e24faea3a403a3b08c8e9ae8bda80f2 100644 (file)
--- 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
 
 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
 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.
 
 
 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
 
 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($$)`
 
 
 #### `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($$)`
 
 
 #### `targetpage($$)`