urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

web commit by joey

master
www-data 2006-05-03 20:43:55 +00:00
parent 1478bab0cd
commit 3900abf314
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/plugins/write.mdwn
View File

@ -37,15 +37,22 @@ page in place of the directive.
Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include: 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 ### 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. 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 ### 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. 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.