summaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-01-29 13:07:17 -0500
committerJoey Hess <joey@kodama.kitenet.net>2008-01-29 13:07:17 -0500
commit95c5cbc721a2382104810e3b4f2bd13b8a56558f (patch)
treea97c006e4a119298c433622e0b0670d1a755376c /doc/plugins/write.mdwn
parent5696b35801e74e84d87643931a3677fba25f4e4a (diff)
document the new refresh hook
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 76fa3f0d7..9e27cc27f 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -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.
+### 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);
-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.