X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/02b9f69ba5da59cca9ff198b731d63d643fff4db..e855e30d01796253a77da4531fcd1f896d9f117a:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 71239ac82..4dd057074 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -80,7 +80,7 @@ make arbitrary changes. The function is passed named parameters `page` and This is identical to a preprocess hook (see below), except that it is called in the initial pass that scans pages for data that will be used in -later passes. Scan hooks are the only hook that should modify +later passes. Scan hooks are the only hook that should modify `%links`. ### preprocess @@ -218,8 +218,8 @@ CGI::FormBuilder]] to generate web forms. These hooks are passed named parameters: `cgi`, `session`, and `form`. These are, respectively, the `CGI` object, the user's `CGI::Session`, and a `CGI::FormBuilder`. -Each time a form is set up, the formbuilder_setup hook is called. -Typically the formbuilder_setup hook will check the form's title, and if +Each time a form is set up, the `formbuilder_setup` hook is called. +Typically the `formbuilder_setup` hook will check the form's title, and if it's a form that it needs to modify, will call various methods to add/remove/change fields, tweak the validation code for the fields, etc. It will not validate or display the form. @@ -264,11 +264,11 @@ hash. The best way to understand the contents of the hash is to look at If your plugin needs to access data about other pages in the wiki. It can use the following hashes, using a page name as the key: -* `%links` lists the names of each page that a page links to, in an array +* `links` lists the names of each page that a page links to, in an array reference. -* `%renderedfiles` lists names of the files rendered by a page, in an array - reference. -* `%pagesources` contains the name of the source file for a page. +* `%destsources` contains the name of the source file used to create each + destination file. +* `%pagesources` contains the name of the source file for each page. Also, the %IkiWiki::version variable contains the version number for the ikiwiki program.