X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/0f25ec8eb640a850a8f1efe7081c03d05d04eda4..b5d3c31edaed159933bff29bdd8462be0e1ccd43:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 57521687e..1beafa395 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -197,15 +197,24 @@ 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. -* `%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. +Also, the %IkiWiki::version variable contains the version number for the +ikiwiki program. + ### Library functions #### `hook(@)` Hook into ikiwiki's processing. See the discussion of hooks above. +Note that in addition to the named parameters described above, a parameter +named no_override is supported, If it's set to a true value, then this hook +will not override any existing hook with the same id. This is useful if +the id can be controled by the user. + #### `debug($)` Logs a debugging message. These are supressed unless verbose mode is turned @@ -293,6 +302,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. +### `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