]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/write.mdwn
* Add the needsbuild hook. Plugins can use this to manipulate which files
[ikiwiki.git] / doc / plugins / write.mdwn
index 8b0cdfdaa2fc1c25e13096447fba577ab9e0b62f..9d85d4a9f04d602ee1a61994ca54468dd06d2999 100644 (file)
@@ -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);