summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-05-09 00:48:09 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-05-09 00:48:09 +0000
commit72c53650ad4a708493880daa75cdda9d056fc75e (patch)
treefa5a977f1b2aca5bde037d74029f069027b9a3bb /doc/plugins
parent127bceef5b4799e58cb068043e49ed16a3ec840d (diff)
* Add the needsbuild hook. Plugins can use this to manipulate which files
ikiwiki builds when refreshing the wiki.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 8b0cdfdaa..9d85d4a9f 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -62,6 +62,15 @@ configuration. It's called early in the startup process. The
function is passed no values. It's ok for the function to call
`error()` if something isn't configured right.
+### needsbuild
+
+ hook(type => "needsbuild", id => "foo", call => \&needsbuild);
+
+This allows a plugin the manipulate the list of files that need to be
+built when the wiki is refreshed. The function is passed a reference to an
+array of pages that will be rebuilt, and can modify the array, either
+adding or removing files from it.
+
### filter
hook(type => "filter", id => "foo", call => \&filter);