From cefbe6210f4e89984bb40062e4f9787b7372dd52 Mon Sep 17 00:00:00 2001 From: joey Date: Sun, 8 Oct 2006 21:56:50 +0000 Subject: * Change %renderedfiles to store an array of files rendered from a given source file, to allow tracking of extra rendered files like rss feeds. * Note that plugins that accessed this variable will need to be updated! The plugin interface has been increased to version 1.01 for this change. * Add will_render function to the plugin interface, used to register that a page renders a destination file, and do some security checks. * Use will_render in the inline and linkmap plugins. * Previously but no longer rendered files will be cleaned up. * You will need to rebuild your wiki on upgrade to this version. --- doc/plugins/write.mdwn | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'doc/plugins/write.mdwn') diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 57521687e..8145a3562 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -197,7 +197,8 @@ 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. ### Library functions @@ -293,6 +294,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 -- cgit v1.2.3