X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b2dea99417ebfee3d448ab6b49ca58cb2780258d..d59b565b530c7334e24bf0ff2dbfcd76785000c6:/doc/plugins/write.mdwn?ds=sidebyside diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 183675c53..35f391f7f 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -92,8 +92,6 @@ function is passed no values. ### needsbuild - - hook(type => "needsbuild", id => "foo", call => \&needsbuild); This allows a plugin to manipulate the list of files that need to be @@ -213,8 +211,8 @@ want to change the default ("page.tmpl"). Template files are looked for in Use this to implement html sanitization or anything else that needs to modify the body of a page after it has been fully converted to html. -The function is passed named parameters: "page" and "content", and -should return the sanitized content. +The function is passed named parameters: "page", "destpage", and "content", +and should return the sanitized content. ### format @@ -363,10 +361,11 @@ next time ikiwiki is run. The hash holds per-page state, so to set a value, use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value, use `%pagestate{$page}{$id}{$key}`. -`$key` can be any string you like, but `$id` must be the same as the "id" -parameter passed to `hook()` when registering the plugin. This is so -ikiwiki can know when to delete pagestate for plugins that are no longer -used. +The `$value` can be anything that perl's Storable module is capable of +serializing. `$key` can be any string you like, but `$id` must be the same +as the "id" parameter passed to `hook()` when registering the plugin. This +is so ikiwiki can know when to delete pagestate for plugins that are no +longer used. When pages are deleted, ikiwiki automatically deletes their pagestate too.