]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
document the new refresh hook
authorJoey Hess <joey@kodama.kitenet.net>
Tue, 29 Jan 2008 18:07:17 +0000 (13:07 -0500)
committerJoey Hess <joey@kodama.kitenet.net>
Tue, 29 Jan 2008 18:07:17 +0000 (13:07 -0500)
doc/plugins/write.mdwn

index 76fa3f0d7e028be4a0272749528d08dbd77e79ad..9e27cc27f8103cecd315d506d4d3f6b2941ccd7a 100644 (file)
@@ -82,11 +82,19 @@ 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.
 
 function is passed no values. It's ok for the function to call
 `error()` if something isn't configured right.
 
+### refresh
+
+       hook(type => "refresh", id => "foo", call => \&refresh);
+
+This hook is called just before ikiwiki scans the wiki for changed files.
+It's useful for plugins that need to create or modify a source page. The
+function is passed no values.
+
 ### needsbuild
 
        hook(type => "needsbuild", id => "foo", call => \&needsbuild);
 
 ### needsbuild
 
        hook(type => "needsbuild", id => "foo", call => \&needsbuild);
 
-This allows a plugin the manipulate the list of files that need to be
+This allows a plugin to 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.
 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.