X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1202b4fd7b305b223d64f9e9f24424b72c81ab6d..a8672085e4ad9e1ba25a5e2d5a590d15c5a3a7bb:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 5547ae699..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. @@ -414,6 +414,15 @@ Given a time, formats it for display. This is the standard gettext function, although slightly optimised. +#### `urlto($$)` + +Construct a relative url to the first parameter from the second. + +#### `targetpage($$)` + +Passed a page and an extension, returns the filename that page will be +rendered to. + ## RCS plugins ikiwiki's support for revision control systems also uses pluggable perl @@ -431,6 +440,7 @@ See [[about_RCS_backends]] for some more info. It's also possible to write plugins that add new functions to [[PageSpecs|PageSpec]]. Such a plugin should add a function to the IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is -how it will be accessed in a [[PageSpec]]. The function will be passed two -parameters: The name of the page being matched, and the thing to match -against. It should return true if the page matches. +how it will be accessed in a [[PageSpec]]. The function will be passed +three parameters: The name of the page being matched, the thing to match +against, and the page that the matching is occuring on. It should return +true if the page matches.