diff options
author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-10-08 21:56:50 +0000 |
---|---|---|
committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-10-08 21:56:50 +0000 |
commit | cefbe6210f4e89984bb40062e4f9787b7372dd52 (patch) | |
tree | 5fd7195d25c124eef90e8d3e66b44ed1fbd8d644 /doc/plugins | |
parent | 118c481766669959c34c30a79aa2667cdcc7aebc (diff) |
* 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.
Diffstat (limited to 'doc/plugins')
-rw-r--r-- | doc/plugins/contrib/img/discussion.mdwn | 4 | ||||
-rw-r--r-- | doc/plugins/write.mdwn | 10 |
2 files changed, 11 insertions, 3 deletions
diff --git a/doc/plugins/contrib/img/discussion.mdwn b/doc/plugins/contrib/img/discussion.mdwn index c72752cf1..d4b38fb61 100644 --- a/doc/plugins/contrib/img/discussion.mdwn +++ b/doc/plugins/contrib/img/discussion.mdwn @@ -43,9 +43,9 @@ Benefits of not scaling: 1. Avoids any security issues with imagemagick. 2. Avoids issue of how to clean up old scaled images that are no longer being used. (Granted, this is a general ikiwiki problem that will eventually - be fixed in a general way.) + be fixed in a general way. (Update: now fixed in a general way, use the + will_render function.)) 3. Makes clicking on thumbnails display the full version really fast, since it's cached. :-) - --[[Joey]] 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 |