## Registering plugins
All plugins should `use IkiWiki` to import the ikiwiki plugin interface.
+It's a good idea to include the version number of the plugin interface that
+your plugin expects: `use IkiWiki 2.00`
Plugins should, when imported, call `hook()` to hook into ikiwiki's
processing. The function uses named parameters, and use varies depending on
a "call" parameter, which is a reference to a function to call for the
hook.
-An optional "scan" parameter, if set to a true value, makes the hook be
-called during the preliminary scan that ikiwiki makes of updated pages,
-before begining to render pages. This parameter should be set to true if
-the hook modifies data in `%links`. Note that doing so will make the hook
-be run twice per page build, so avoid doing it for expensive hooks.
-
An optional "last" parameter, if set to a true value, makes the hook run
after all other hooks of its type. Useful if the hook depends on some other
hook being run first.
make arbitrary changes. The function is passed named parameters `page` and
`content` and should return the filtered content.
-### scan
-
- hook(type => "scan", id => "foo", call => \&scan);
-
-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
-
### preprocess
Adding a [[PreProcessorDirective]] is probably the most common use of a
well. Whatever the function returns goes onto the page in place of the
directive.
+An optional "scan" parameter, if set to a true value, makes the hook be
+called during the preliminary scan that ikiwiki makes of updated pages,
+before begining to render pages. This parameter should be set to true if
+the hook modifies data in `%links`. Note that doing so will make the hook
+be run twice per page build, so avoid doing it for expensive hooks.
+
Note that if the [[htmlscrubber]] is enabled, html in
[[PreProcessorDirective]] output is sanitised, which may limit what your
plugin can do. Also, the rest of the page content is not in html format at
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.
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
- reference.
-* `%renderedfiles` lists names of the files rendered by a page, in an array
+* `links` lists the names of each page that a page links to, 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.
Makes the specified page depend on the specified [[PageSpec]].
-#### `pagespec_match($$;$)`
+#### `pagespec_match($$;@)`
-Passed a page name, a [[PageSpec]], and the location the [[PageSpec]] should
-be matched against, returns true if the [[PageSpec]] matches the page. (If
-the third parameter is not passed, relative PageSpecs will match relative to
-the top of the wiki.)
+Passed a page name, and [[PageSpec]], returns true if the [[PageSpec]]
+matches the page.
+
+Additional named parameters can be passed, to further limit the match.
+The most often used is "location", which specifies the location the
+PageSpec should match against. If not passed, relative PageSpecs will match
+relative to the top of the wiki.
#### `bestlink($$)`
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
[[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
-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.
+two parameters: The name of the page being matched, and the thing to match
+against. It may also be passed additional, named parameters. It should return
+a IkiWiki::SuccessReason object if the match succeeds, or an
+IkiWiki::FailReason object if the match fails.