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

document that state variables are not available in the checkconfig hook

master
Joey Hess 2010-01-31 14:03:19 -05:00
parent a2ee2aa9c7
commit 1e0b724bac
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/plugins/write.mdwn
View File

@ -68,20 +68,21 @@ In roughly the order they are called.
This allows for plugins to perform their own processing of command-line
options and so add options to the ikiwiki command line. It's called during
command line processing, with @ARGV full of any options that ikiwiki was
command line processing, with `@ARGV` full of any options that ikiwiki was
not able to process on its own. The function should process any options it
can, removing them from @ARGV, and probably recording the configuration
settings in %config. It should take care not to abort if it sees
can, removing them from `@ARGV`, and probably recording the configuration
settings in `%config`. It should take care not to abort if it sees
an option it cannot process, and should just skip over those options and
leave them in @ARGV.
leave them in `@ARGV`.
### checkconfig
hook(type => "checkconfig", 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 startup process. The
function is passed no values. It's ok for the function to call
configuration. It's called early in the startup process. `%config`
is populated at this point, but other state has not yet been loaded.
The function is passed no values. It's ok for the function to call
`error()` if something isn't configured right.
### refresh