web commit by joey

[ikiwiki.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 165627f99fc0d7c71380fc706e0e2aa75474d2a4..db1badb7c4efec5b759f4f0b549a5d88342f8c42 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -37,15 +37,22 @@ page in place of the directive.
 
 Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include:
 
+### checkconfig
+
+        IkiWiki::hook(type => "delete", id => "foo", call => \&checkconfig);
+
+This is useful if the plugin needs to check for, or modify ikiwiki's configuration. It's called early in the ikiwiki startup process. It's ok for
+the function to call IkiWiki::error if something isn't configured right.
+
 ### delete
 
-        IkiWiki::hook(type => "delete", id => "foo", call => \&deletion);
+        IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
 
 Each time a page or pages is removed from the wiki, the referenced function is called, and passed the names of the source files that were removed.
 
 ### render
 
-        IkiWiki::hook(type => "render", id => "foo", call => \&update);
+        IkiWiki::hook(type => "render", id => "foo", call => \&render);
 
 Each time ikiwiki renders a change or addition (but not deletion) of a page to the wiki, the referenced function is called, and passed the name of the source file that was rendered.