web commit by SteveRobbins: Downgrade fixed problem

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 57521687e10a7534e55df59be277a9e000a9dfff..18aa34dca7b304f9028c6d3b5a98583aa91e75a1 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -197,9 +197,13 @@ use the following hashes, using a page name as the key:
 
 * `%links` lists the names of each page that a page links to, in an array
   reference.
 
 * `%links` lists the names of each page that a page links to, in an array
   reference.

-* `%renderedfiles` contains the name of the file rendered by a page.
+* `%renderedfiles` lists names of the files rendered by a page, in an array
+  reference.

 * `%pagesources` contains the name of the source file for a page.
 
 * `%pagesources` contains the name of the source file for a page.
 

+Also, the %IkiWiki::version variable contains the version number for the
+ikiwiki program.
+

 ### Library functions
 
 #### `hook(@)`
 ### Library functions
 
 #### `hook(@)`


@@ -293,6 +297,13 @@ 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($$)`
+
+Given a page name and a destination file name (not including the base
+destination directory), register that the page will result in that file
+being rendered. It's important to call this before writing to any file in
+the destination directory.
+

 #### `pagetype($)`
 
 Given the name of a source file, returns the type of page it is, if it's
 #### `pagetype($)`
 
 Given the name of a source file, returns the type of page it is, if it's