Add link to hooks definition in compiler highlevel description. Fixed some typos.
[ikiwiki.git] / doc / plugins / write.mdwn
1 Ikiwiki's plugin interface allows all kinds of useful [[plugins]] to be
2 written to extend ikiwiki in many ways. Despite the length of this page,
3 it's not really hard. This page is a complete reference to everything a
4 plugin might want to do. There is also a quick [[tutorial]].
5
6 [[!template id="note" text="""
7 Ikiwiki is a compiler
8
9 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
10 *compiler*. So plugins influence pages when they are built, not when they
11 are loaded. A plugin that inserts the current time into a page, for
12 example, will insert the build time.
13
14 Also, as a compiler, ikiwiki avoids rebuilding pages unless they have
15 changed, so a plugin that prints some random or changing thing on a page
16 will generate a static page that won't change until ikiwiki rebuilds the
17 page for some other reason, like the page being edited.
18
19 The [[tutorial]] has some other examples of ways that ikiwiki being a
20 compiler may trip up the unwary.
21 """]]
22
23 [[!toc levels=2]]
24
25 ## Highlevel view of ikiwiki
26
27 Ikiwiki mostly has two modes of operation. It can either be running
28 as a compiler, building or updating a wiki; or as a cgi program, providing
29 user interface for editing pages, etc. Almost everything ikiwiki does
30 is accomplished by calling various hooks provided by plugins.
31
32 ### compiler
33
34 As a compiler, ikiwiki starts by calling the
35 [[`refresh`|plugins/write#refresh]] hook. Then it checks the wiki's source to
36 find new or changed pages. The [[`needsbuild`|plugins/write#needsbuild]] hook
37 is then called to allow manipulation of the list of pages that need to be
38 built.
39
40 Now that it knows what pages it needs to build, ikiwiki runs two compile
41 passes. First, it runs [[`scan`|plugins/write#scan]] hooks, which collect
42 metadata about the pages. Then it runs a page rendering pipeline, by calling
43 in turn these hooks: [[`filter`|plugins/write#filter]],
44 [[`preprocess`|plugins/write#preprocess]],
45 [[`linkify`|plugins/write#linkify]], [[`htmlize`|plugins/write#htmlize]],
46 [[`indexhtml`|plugins/write#indexhtml]],
47 [[`pagetemplate`|plugins/write#pagetemplate]],
48 [[`sanitize`|plugins/write#sanitize]], [[`format`|plugins/write#format]].
49
50 After all necessary pages are built, it calls the
51 [[`changes`|plugins/write#changes]] hook. Finally, if a page was deleted, the
52 [[`delete`|plugins/write#delete]] hook is called, and the files that page had
53 previously produced are removed.
54
55 ### cgi
56
57 The flow between hooks when ikiwiki is run as a cgi is best illustrated by
58 an example.
59
60 Alice browses to a page and clicks Edit.
61
62 * Ikiwiki is run as a cgi. It assigns Alice a session cookie, and,
63   by calling the `auth` hooks, sees that she is not yet logged in.
64 * The `sessioncgi` hooks are then called, and one of them,
65   from the [[editpage]] plugin, notices that the cgi has been told "do=edit".
66 * The [[editpage]] plugin calls the `canedit` hook to check if this
67   page edit is allowed. The [[signinedit]] plugin has a hook that says not:
68   Alice is not signed in.
69 * The [[signinedit]] plugin then launches the signin process. A signin
70   page is built by calling the `formbuilder_setup` hook.
71
72 Alice signs in with her openid.
73
74 * The [[openid]] plugin's `formbuilder` hook sees that an openid was
75   entered in the signin form, and redirects to Alice's openid provider.
76 * Alice's openid provider calls back to ikiwiki. The [[openid]] plugin
77   has an `auth` hook that finishes the openid signin process.
78 * Signin complete, ikiwiki returns to what Alice was doing before; editing
79   a page.
80 * Now all the `canedit` hooks are happy. The [[editpage]] plugin calls
81   `formbuilder_setup` to display the page editing form.
82
83 Alice saves her change to the page.
84
85 * The [[editpage]] plugin's `formbuilder` hook sees that the Save button
86   was pressed, and calls the `checkcontent` and `editcontent` hooks.
87   Then it saves the page to disk, and branches into the compiler part
88   of ikiwiki to refresh the wiki.
89
90 ## Types of plugins
91
92 Most ikiwiki [[plugins]] are written in perl, like ikiwiki. This gives the
93 plugin full access to ikiwiki's internals, and is the most efficient.
94 However, plugins can actually be written in any language that supports XML
95 RPC. These are called [[external]] plugins.
96
97 A plugin written in perl is a perl module, in the `IkiWiki::Plugin`
98 namespace. The name of the plugin is typically in lowercase, such as
99 `IkiWiki::Plugin::inline`. Ikiwiki includes a `IkiWiki::Plugin::skeleton`
100 that can be fleshed out to make a useful plugin.
101 `IkiWiki::Plugin::pagecount` is another simple example. All perl plugins
102 should `use IkiWiki` to import the ikiwiki plugin interface. It's a good
103 idea to include the version number of the plugin interface that your plugin
104 expects: `use IkiWiki 3.00`.
105
106 An external plugin is an executable program. It can be written in any
107 language. Its interface to ikiwiki is via XML RPC, which it reads from
108 ikiwiki on its standard input, and writes to ikiwiki on its standard
109 output. For more details on writing external plugins, see [[external]].
110
111 Despite these two types of plugins having such different interfaces,
112 they're the same as far as how they hook into ikiwiki. This document will
113 explain how to write both sorts of plugins, albeit with an emphasis on perl
114 plugins.
115
116 ## Plugin interface
117
118 To import the ikiwiki plugin interface:
119
120         use IkiWiki '3.00';
121
122 This will import several variables and functions into your plugin's
123 namespace. These variables and functions are the ones most plugins need,
124 and a special effort will be made to avoid changing them in incompatible
125 ways, and to document any changes that have to be made in the future.
126
127 Note that IkiWiki also provides other variables and functions that are not
128 exported by default. No guarantee is made about these in the future, so if
129 it's not exported, the wise choice is to not use it.
130
131 ## Registering plugins
132
133 Plugins should, when imported, call `hook()` to hook into ikiwiki's
134 processing. The function uses named parameters, and use varies depending on
135 the type of hook being registered -- see below. A plugin can call
136 the function more than once to register multiple hooks.
137
138 All calls to `hook()` should be passed a "type" parameter, which gives the
139 type of hook, a "id" parameter, which should be a unique string for this
140 plugin, and a "call" parameter, which tells what function to call for the
141 hook.
142
143 An optional "last" parameter, if set to a true value, makes the hook run
144 after all other hooks of its type, and an optional "first" parameter makes
145 it run first. Useful if the hook depends on some other hook being run first.
146
147 ## Types of hooks
148
149 In roughly the order they are called.
150
151 ### getopt
152
153         hook(type => "getopt", id => "foo", call => \&getopt);
154
155 This allows for plugins to perform their own processing of command-line
156 options and so add options to the ikiwiki command line. It's called during
157 command line processing, with `@ARGV` full of any options that ikiwiki was
158 not able to process on its own. The function should process any options it
159 can, removing them from `@ARGV`, and probably recording the configuration
160 settings in `%config`. It should take care not to abort if it sees
161 an option it cannot process, and should just skip over those options and
162 leave them in `@ARGV`.
163
164 ### checkconfig
165
166         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
167
168 This is useful if the plugin needs to check for or modify ikiwiki's
169 configuration. It's called early in the startup process. `%config`
170 is populated at this point, but other state has not yet been loaded.
171 The function is passed no values. It's ok for the function to call
172 `error()` if something isn't configured right.
173
174 ### <a name="refresh">refresh</a>
175
176         hook(type => "refresh", id => "foo", call => \&refresh);
177
178 This hook is called just before ikiwiki scans the wiki for changed files.
179 It's useful for plugins that need to create or modify a source page. The
180 function is passed no values.
181
182 ### <a name="needsbuild">needsbuild</a>
183
184         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
185
186 This allows a plugin to observe or even manipulate the list of files that
187 need to be built when the wiki is refreshed. 
188
189 As its first parameter, the function is passed a reference to an array of
190 files that will be built. It should return an array reference that is a
191 modified version of its input. It can add or remove files from it.
192
193 The second parameter passed to the function is a reference to an array of
194 files that have been deleted.
195
196 ### <a name="scan">scan</a>
197
198         hook(type => "scan", id => "foo", call => \&scan);
199
200 This hook is called early in the process of building the wiki, and is used
201 as a first pass scan of the page, to collect metadata about the page. It's
202 mostly used to scan the page for [[WikiLinks|ikiwiki/WikiLink]], and add
203 them to `%links`. Present in IkiWiki 2.40 and later.
204
205 The function is passed named parameters "page" and "content". Its return
206 value is ignored.
207
208 ### <a name="filter">filter</a>
209
210         hook(type => "filter", id => "foo", call => \&filter);
211
212 Runs on the full raw source of a page, before anything else touches it, and
213 can make arbitrary changes. The function is passed named parameters "page",
214 "destpage", and "content". It should return the filtered content.
215
216 ### <a name="preprocess">preprocess</a>
217
218 Adding a preprocessor [[ikiwiki/directive]] is probably the most common use
219 of a plugin.
220
221         hook(type => "preprocess", id => "foo", call => \&preprocess);
222
223 Replace "foo" with the command name that will be used for the preprocessor
224 directive.
225
226 Each time the directive is processed, the referenced function (`preprocess`
227 in the example above) is called. Whatever the function returns goes onto
228 the page in place of the directive. Or, if the function aborts using
229 `error()`, the directive will be replaced with the error message.
230
231 The function is passed named parameters. First come the parameters set
232 in the preprocessor directive. These are passed in the same order as
233 they're in the directive, and if the preprocessor directive contains a bare
234 parameter (example: `\[[!foo param]]`), that parameter will be passed with
235 an empty value.
236
237 After the parameters from the preprocessor directive some additional ones
238 are passed: A "page" parameter gives the name of the page that embedded the
239 preprocessor directive, while a "destpage" parameter gives the name of the
240 page the content is going to (different for inlined pages), and a "preview"
241 parameter is set to a true value if the page is being previewed.
242
243 If `hook` is passed an optional "scan" parameter, set to a true value, this
244 makes the hook be called during the preliminary scan that ikiwiki makes of
245 updated pages, before begining to render pages. This should be done if the
246 hook modifies data in `%links` (typically by calling `add_link`). Note that
247 doing so will make the hook be run twice per page build, so avoid doing it
248 for expensive hooks. (As an optimisation, if your preprocessor hook is
249 called in a void context, you can assume it's being run in scan mode, and
250 avoid doing expensive things at that point.)
251
252 Note that if the [[htmlscrubber]] is enabled, html in
253 preprocessor [[ikiwiki/directive]] output is sanitised, which may limit what
254 your plugin can do. Also, the rest of the page content is not in html
255 format at preprocessor time. Text output by a preprocessor directive will
256 be linkified and passed through markdown (or whatever engine is used to
257 htmlize the page) along with the rest of the page.
258
259 ### <a name="linkify">linkify</a>
260
261         hook(type => "linkify", id => "foo", call => \&linkify);
262
263 This hook is called to convert [[WikiLinks|ikiwiki/WikiLink]] on the page into html
264 links. The function is passed named parameters "page", "destpage", and
265 "content". It should return the linkified content.  Present in IkiWiki 2.40
266 and later.
267
268 Plugins that implement linkify must also implement a scan hook, that scans
269 for the links on the page and adds them to `%links` (typically by calling
270 `add_link`).
271
272 ### <a name="htmlize">htmlize</a>
273
274         hook(type => "htmlize", id => "ext", call => \&htmlize);
275
276 Runs on the source of a page and turns it into html. The id parameter
277 specifies the filename extension that a file must have to be htmlized using
278 this plugin. This is how you can add support for new and exciting markup
279 languages to ikiwiki.
280
281 The function is passed named parameters: "page" and "content" and should
282 return the htmlized content.
283
284 If `hook` is passed an optional "keepextension" parameter, set to a true
285 value, then the extension will not be stripped from the source filename when
286 generating the page.
287
288 If `hook` is passed an optional "noextension" parameter, set to a true
289 value, then the id parameter specifies not a filename extension, but
290 a whole filename that can be htmlized. This is useful for files
291 like `Makefile` that have no extension.
292
293 If `hook` is passed an optional "longname" parameter, this value is used
294 when prompting a user to choose a page type on the edit page form.
295
296 ### <a name="indexhtml">indexhtml</a>
297
298         hook(type => "indexhtml", id => "foo", call => \&indexhtml);
299
300 This hook is called once the page has been converted to html (but before
301 the generated html is put in a template). The most common use is to
302 update search indexes. Added in ikiwiki 2.54.
303
304 The function is passed named parameters "page", "destpage", and "content".
305 Its return value is ignored.
306
307 ### <a name="pagetemplate">pagetemplate</a>
308
309         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
310
311 [[Templates]] are filled out for many different things in
312 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
313 a cgi. This hook allows modifying the variables available on those
314 templates. The function is passed named parameters. The "page" and
315 "destpage" parameters are the same as for a preprocess hook. The "template"
316 parameter is a [[!cpan HTML::Template]] object that is the template that
317 will be used to generate the page. The function can manipulate that
318 template object.
319
320 The most common thing to do is probably to call `$template->param()` to add
321 a new custom parameter to the template.
322
323 ### templatefile
324
325         hook(type => "templatefile", id => "foo", call => \&templatefile);
326
327 This hook allows plugins to change the [[template|templates]] that is
328 used for a page in the wiki. The hook is passed a "page" parameter, and
329 should return the name of the template file to use (relative to the
330 template directory), or undef if it doesn't want to change the default
331 ("page.tmpl").
332
333 ### pageactions
334
335         hook(type => "pageactions", id => "foo", call => \&pageactions);
336
337 This hook allows plugins to add arbitrary actions to the action bar on a
338 page (next to Edit, RecentChanges, etc). The hook is passed a "page"
339 parameter, and can return a list of html fragments to add to the action
340 bar.
341
342 ### <a name="sanitize">sanitize</a>
343
344         hook(type => "sanitize", id => "foo", call => \&sanitize);
345
346 Use this to implement html sanitization or anything else that needs to
347 modify the body of a page after it has been fully converted to html.
348
349 The function is passed named parameters: "page", "destpage", and "content",
350 and should return the sanitized content.
351
352 ### <a name="format">format</a>
353
354         hook(type => "format", id => "foo", call => \&format);
355
356 The difference between format and sanitize is that sanitize only acts on
357 the page body, while format can modify the entire html page including the
358 header and footer inserted by ikiwiki, the html document type, etc. (It
359 should not rely on always being passed the entire page, as it won't be
360 when the page is being previewed.)
361
362 The function is passed named parameters: "page" and "content", and 
363 should return the formatted content.
364
365 ### build_affected
366
367         hook(type => "build_affected", id => "foo", call => \&build_affected);
368
369 This hook is called after the directly changed pages have been built,
370 and can cause extra pages to be built. If links and backlinks were provided
371 by a plugin, this would be where that plugin would rebuild pages whose
372 backlinks have changed, for instance. The [[trail]] plugin uses this hook
373 to rebuild pages whose next or previous page has changed.
374
375 The function should currently ignore its parameters. It returns a list with
376 an even number of items (a hash in list context), where the first item of
377 each pair is a page name to be rebuilt (if it was not already rebuilt), and
378 the second is a log message resembling
379 `building plugins/write because the phase of the moon has changed`.
380
381 ### <a name="delete">delete</a>
382
383         hook(type => "delete", id => "foo", call => \&delete);
384
385 After a page or pages is removed from the wiki, the referenced function
386 is called, and passed the names of the source files that were removed.
387
388 ### rendered
389
390         hook(type => "rendered", id => "foo", call => \&rendered);
391
392 After ikiwiki renders a change or addition (but not deletion) to the
393 wiki, the referenced function is called, and passed the names of the
394 source files that were rendered.
395
396 (This hook used to be called "change", but that was not accurate.
397 For now, plugins using the old hook name will still work.)
398
399 ### <a name="changes">changes</a>
400
401         hook(type => "changes", id => "foo", call => \&changes);
402
403 After ikiwiki renders changes to the wiki, the referenced function is
404 called, and passed the names of the source files that were added, modified,
405 or deleted.
406
407 ### cgi
408
409         hook(type => "cgi", id => "foo", call => \&cgi);
410
411 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
412 called in turn, and passed a CGI object. The hook should examine the
413 parameters, and if it will handle this CGI request, output a page
414 (including the http headers) and terminate the program.
415
416 Note that cgi hooks are called as early as possible, before any ikiwiki
417 state is loaded, and with no session information.
418
419 ### auth
420
421         hook(type => "auth", id => "foo", call => \&auth);
422
423 This hook can be used to implement an authentication method. When a user
424 needs to be authenticated, each registered auth hook is called in turn, and
425 passed a CGI object and a session object. 
426
427 If the hook is able to authenticate the user, it should set the session
428 object's "name" parameter to the authenticated user's name. Note that
429 if the name is set to the name of a user who is not registered,
430 a basic registration of the user will be automatically performed.
431
432 ### sessioncgi
433
434         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
435
436 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
437 is only run once a session object is available. It is passed both a CGI
438 object and a session object. To check if the user is in fact signed in, you
439 can check if the session object has a "name" parameter set.
440
441 ### canedit
442
443         hook(type => "canedit", id => "foo", call => \&canedit);
444
445 This hook can be used to implement arbitrary access methods to control when
446 a page can be edited using the web interface (commits from revision control
447 bypass it). When a page is edited, each registered canedit hook is called
448 in turn, and passed the page name, a CGI object, and a session object.
449
450 If the hook has no opinion about whether the edit can proceed, return
451 `undef`, and the next plugin will be asked to decide. If edit can proceed,
452 the hook should return "". If the edit is not allowed by this hook, the
453 hook should return an error message for the user to see, or a function 
454 that can be run to log the user in or perform other action necessary for
455 them to be able to edit the page.
456
457 This hook should avoid directly redirecting the user to a signin page,
458 since it's sometimes used to test to see which pages in a set of pages a
459 user can edit.
460
461 ### canremove
462
463         hook(type => "canremove", id => "foo", call => \&canremove);
464
465 This hook can be used to implement arbitrary access methods to control
466 when a page can be removed using the web interface (commits from
467 revision control bypass it). It works exactly like the `canedit` hook,
468 but is passed the named parameters `cgi` (a CGI object), `session`
469 (a session object) and `page` (the page subject to deletion).
470
471 ### canrename
472
473         hook(type => "canrename", id => "foo", call => \&canrename);
474
475 This hook can be used to implement arbitrary access methods to control when
476 a page can be renamed using the web interface (commits from revision control
477 bypass it). It works exactly like the `canedit` hook,
478 but is passed the named parameters `cgi` (a CGI object), `session` (a
479 session object), `src`, `srcfile`, `dest` and `destfile`.
480
481 ### checkcontent
482         
483         hook(type => "checkcontent", id => "foo", call => \&checkcontent);
484
485 This hook is called to check the content a user has entered on a page,
486 before it is saved, and decide if it should be allowed.
487
488 It is passed named parameters: `content`, `page`, `cgi`, and `session`. If
489 the content the user has entered is a comment, it may also be passed some
490 additional parameters: `author`, `url`, and `subject`. The `subject`
491 parameter may also be filled with the user's comment about the change.
492
493 Note: When the user edits an existing wiki page, this hook is also
494 passed a `diff` named parameter, which will include only the lines
495 that they added to the page, or modified.
496
497 The hook should return `undef` on success. If the content is disallowed, it
498 should return a message stating what the problem is, or a function
499 that can be run to perform whatever action is necessary to allow the user
500 to post the content.
501
502 ### editcontent
503
504         hook(type => "editcontent", id => "foo", call => \&editcontent);
505
506 This hook is called when a page is saved (or previewed) using the web
507 interface. It is passed named parameters: `content`, `page`, `cgi`, and
508 `session`. These are, respectively, the new page content as entered by the
509 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
510
511 It can modify the content as desired, and should return the content.
512
513 ### formbuilder
514
515         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
516         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
517
518 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
519 CGI::FormBuilder]] to generate web forms. These hooks are passed named
520 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
521 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
522 reference to an array of names of buttons to go on the form.
523
524 Each time a form is set up, the `formbuilder_setup` hook is called.
525 Typically the `formbuilder_setup` hook will check the form's title, and if
526 it's a form that it needs to modify, will call various methods to
527 add/remove/change fields, tweak the validation code for the fields, etc. It
528 will not validate or display the form.
529
530 Just before a form is displayed to the user, the `formbuilder` hook is
531 called. It can be used to validate the form, but should not display it.
532
533 ### savestate
534
535         hook(type => "savestate", id => "foo", call => \&savestate);
536
537 This hook is called whenever ikiwiki normally saves its state, just before
538 the state is saved. The function can save other state, modify values before
539 they're saved, etc.
540
541 ### renamepage
542
543         hook(type => "renamepage", id => "foo", call => \&renamepage);
544
545 This hook is called by the [[plugins/rename]] plugin when it renames
546 something, once per page linking to the renamed page's old location.
547 The hook is passed named parameters: `page`, `oldpage`, `newpage`, and
548 `content`, and should try to modify the content of `page` to reflect
549 the name change. For example, by converting links to point to the
550 new page.
551
552 ### rename
553
554         hook(type => "rename", id => "foo", call => \&rename);
555
556 When a page or set of pages is renamed, the referenced function is
557 called for every page, and is passed named parameters:
558
559 * `torename`: a reference to a hash with keys: `src`, `srcfile`,
560   `dest`, `destfile`, `required`.
561 * `cgi`: a CGI object
562 * `session`: a session object.
563
564 Such a hook function returns any additional rename hashes it wants to
565 add. This hook is applied recursively to returned additional rename
566 hashes, so that it handles the case where two plugins use the hook:
567 plugin A would see when plugin B adds a new file to be renamed.
568
569 ### getsetup
570
571         hook(type => "getsetup", id => "foo", call => \&getsetup);
572
573 This hooks is not called during normal operation, but only when setting up 
574 the wiki, or generating a setup file. Plugins can use this hook to add
575 configuration options.
576
577 The hook is passed no parameters. It returns data about the configuration
578 options added by the plugin. It can also check if the plugin is usable, and
579 die if not, which will cause the plugin to not be offered in the configuration
580 interface.
581
582 The data returned is a list of `%config` options, followed by a hash
583 describing the option. There can also be an item named "plugin", which
584 describes the plugin as a whole. For example:
585
586                 return
587                         plugin => {
588                                 description => "description of this plugin",
589                                 safe => 1,
590                                 rebuild => 1,
591                                 section => "misc",
592                         },
593                         option_foo => {
594                                 type => "boolean",
595                                 description => "enable foo?",
596                                 advanced => 1,
597                                 safe => 1,
598                                 rebuild => 1,
599                         },
600                         option_bar => {
601                                 type => "string",
602                                 example => "hello",
603                                 description => "option bar",
604                                 safe => 1,
605                                 rebuild => 0,
606                         },
607
608 * `type` can be "boolean", "string", "integer", "pagespec",
609   or "internal" (used for values that are not user-visible). The type is
610   the type of the leaf values;  the `%config` option may be an array or
611   hash of these.
612 * `example` can be set to an example value.
613 * `description` is a short description of the option.
614 * `link` is a link to further information about the option. This can either
615   be a [[ikiwiki/WikiLink]], or an url.
616 * `htmldescription` is displayed instead of the description by websetup.
617 * `advanced` can be set to true if the option is more suitable for advanced
618   users.
619 * `safe` should be false if the option should not be displayed in unsafe
620   configuration methods, such as the web interface. Anything that specifies
621   a command to run, a path on disk, or a regexp should be marked as unsafe.
622   If a plugin is marked as unsafe, that prevents it from being
623   enabled/disabled.
624 * `rebuild` should be true if changing the option (or enabling/disabling
625   the plugin) will require a wiki rebuild, false if no rebuild is needed,
626   and undef if a rebuild could be needed in some circumstances, but is not
627   strictly required.
628 * `section` can optionally specify which section in the config file
629   the plugin fits in. The convention is to name the sections the
630   same as the tags used for [[plugins|plugin]] on this wiki.
631
632 ### genwrapper
633
634         hook(type => "genwrapper", id => "foo", call => \&genwrapper);
635
636 This hook is used to inject C code (which it returns) into the `main`
637 function of the ikiwiki wrapper when it is being generated. 
638
639 The code runs before anything else -- in particular it runs before
640 the suid wrapper has sanitized its environment.
641
642 ### disable
643
644         hook(type => "disable", id => "foo", call => \&disable);
645
646 This hook is only run when a previously enabled plugin gets disabled
647 during ikiwiki setup. Plugins can use this to perform cleanups.
648
649 ## Exported variables
650
651 Several variables are exported to your plugin when you `use IkiWiki;`
652
653 ### `%config`
654
655 A plugin can access the wiki's configuration via the `%config`
656 hash. The best way to understand the contents of the hash is to look at
657 your ikiwiki setup file, which sets the hash content to configure the wiki.
658
659 ### `%pagestate`
660
661 The `%pagestate` hash can be used by plugins to save state that they will need
662 next time ikiwiki is run. The hash holds per-page state, so to set a value,
663 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
664 use `$pagestate{$page}{$id}{$key}`.
665
666 The `$value` can be anything that perl's Storable module is capable of
667 serializing. `$key` can be any string you like, but `$id` must be the same
668 as the "id" parameter passed to `hook()` when registering the plugin. This
669 is so ikiwiki can know when to delete pagestate for plugins that are no
670 longer used.
671
672 When pages are deleted, ikiwiki automatically deletes their pagestate too.
673
674 Note that page state does not persist across wiki rebuilds, only across
675 wiki updates.
676
677 ### `%wikistate`
678
679 The `%wikistate` hash can be used by a plugin to store persistant state
680 that is not bound to any one page. To set a value, use
681 `$wikistate{$id}{$key}=$value, where `$value` is anything Storable can
682 serialize, `$key` is any string you like, and `$id` must be the same as the
683 "id" parameter passed to `hook()` when registering the plugin, so that the
684 state can be dropped if the plugin is no longer used.
685
686 ### `%links`
687
688 The `%links` hash can be used to look up the names of each page that
689 a page links to. The name of the page is the key; the value is an array
690 reference. Do not modify this hash directly; call `add_link()`.
691
692         $links{"foo"} = ["bar", "baz"];
693
694 ### `%typedlinks`
695
696 The `%typedlinks` hash records links of specific types. Do not modify this
697 hash directly; call `add_link()`. The keys are page names, and the values
698 are hash references. In each page's hash reference, the keys are link types
699 defined by plugins, and the values are hash references with link targets
700 as keys, and 1 as a dummy value, something like this:
701
702         $typedlinks{"foo"} = {
703                 tag => { short_word => 1, metasyntactic_variable => 1 },
704                 next_page => { bar => 1 },
705         };
706
707 Ordinary [[WikiLinks|ikiwiki/WikiLink]] appear in `%links`, but not in
708 `%typedlinks`.
709
710 ### `%pagesources`
711
712 The `%pagesources` has can be used to look up the source filename
713 of a page. So the key is the page name, and the value is the source
714 filename. Do not modify this hash.
715
716         $pagesources{"foo"} = "foo.mdwn";
717
718 ### `%destsources`
719
720 The `%destsources` hash records the name of the source file used to
721 create each destination file. The key is the output filename (ie,
722 "foo/index.html"), and the value is the source filename that it was built
723 from (eg, "foo.mdwn"). Note that a single source file may create multiple
724 destination files. Do not modify this hash directly; call `will_render()`.
725         
726         $destsources{"foo/index.html"} = "foo.mdwn";
727
728 ## Library functions
729
730 Several functions are exported to your plugin when you `use IkiWiki;`
731
732 ### `hook(@)`
733
734 Hook into ikiwiki's processing. See the discussion of hooks above.
735
736 Note that in addition to the named parameters described above, a parameter
737 named `no_override` is supported, If it's set to a true value, then this hook
738 will not override any existing hook with the same id. This is useful if
739 the id can be controled by the user.
740
741 ### `debug($)`
742
743 Logs a debugging message. These are supressed unless verbose mode is turned
744 on.
745
746 ### `error($;$)`
747
748 Aborts with an error message. If the second parameter is passed, it is a
749 function that is called after the error message is printed, to do any final
750 cleanup.
751
752 If called inside a preprocess hook, error() does not abort the entire
753 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
754 a version containing the error message.
755
756 In other hooks, error() is a fatal error, so use with care. Try to avoid
757 dying on bad input when building a page, as that will halt
758 the entire wiki build and make the wiki unusable.
759
760 ### `template($;@)`
761
762 Creates and returns a [[!cpan HTML::Template]] object. (In a list context,
763 returns the parameters needed to construct the obhect.) 
764
765 The first parameter is the name of the template file. The optional remaining
766 parameters are passed to `HTML::Template->new`.
767
768 Normally, the template file is first looked for in the templates/ subdirectory
769 of the srcdir. Failing that, it is looked for in the templatedir.
770
771 Wiki pages can be used as templates. This should be done only for templates
772 which it is safe to let wiki users edit. Enable it by passing a filename
773 with no ".tmpl" extension. Template pages are normally looked for in
774 the templates/ directory. If the page name starts with "/", a page
775 elsewhere in the wiki can be used.
776
777 If the template is not found, or contains a syntax error, an error is thrown.
778
779 ### `template_depends($$;@)`
780
781 Use this instead of `template()` if the content of a template is being
782 included into a page. This causes the page to depend on the template,
783 so it will be updated if the template is modified.
784
785 Like `template()`, except the second parameter is the page.
786
787 ### `htmlpage($)`
788
789 Passed a page name, returns the base name that will be used for a the html
790 page created from it. (Ie, it appends ".html".)
791
792 Use this when constructing the filename of a html file. Use `urlto` when
793 generating a link to a page.
794
795 ### `pagespec_match_list($$;@)`
796
797 Passed a page name, and [[ikiwiki/PageSpec]], returns a list of pages
798 in the wiki that match the [[ikiwiki/PageSpec]]. 
799
800 The page will automatically be made to depend on the specified
801 [[ikiwiki/PageSpec]], so `add_depends` does not need to be called. This
802 is often significantly more efficient than calling `add_depends` and
803 `pagespec_match` in a loop. You should use this anytime a plugin
804 needs to match a set of pages and do something based on that list.
805
806 Unlike pagespec_match, this may throw an error if there is an error in
807 the pagespec.
808
809 Additional named parameters can be specified:
810
811 * `deptype` optionally specifies the type of dependency to add. Use the
812   `deptype` function to generate a dependency type.
813 * `filter` is a reference to a function, that is called and passed a page,
814   and returns true if the page should be filtered out of the list.
815 * `sort` specifies a sort order for the list. See
816   [[ikiwiki/PageSpec/sorting]] for the avilable sort methods. Note that
817   if a sort method is specified that depends on the
818   page content (such as 'meta(foo)'), the deptype needs to be set to
819   a content dependency.
820 * `reverse` if true, sorts in reverse.
821 * `num` if nonzero, specifies the maximum number of matching pages that
822   will be returned.
823 * `list` makes it only match amoung the specified list of pages.
824   Default is to match amoung all pages in the wiki.
825
826 Any other named parameters are passed on to `pagespec_match`, to further
827 limit the match.
828
829 ### `add_depends($$;$)`
830
831 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
832
833 By default, dependencies are full content dependencies, meaning that the
834 page will be updated whenever anything matching the PageSpec is modified.
835 This can be overridden by passing a `deptype` value as the third parameter.
836
837 ### `pagespec_match($$;@)`
838
839 Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
840 [[ikiwiki/PageSpec]] matches the page.
841
842 Note that the return value is overloaded. If stringified, it will be a
843 message indicating why the PageSpec succeeded, or failed, to match the
844 page.
845
846 Additional named parameters can be passed, to further limit the match.
847 The most often used is "location", which specifies the location the
848 PageSpec should match against. If not passed, relative PageSpecs will match
849 relative to the top of the wiki.
850
851 ### `deptype(@)`
852
853 Use this function to generate ikiwiki's internal representation of a
854 dependency type from one or more of these keywords:
855
856 * `content` is the default. Any change to the content
857   of a page triggers the dependency.
858 * `presence` is only triggered by a change to the presence
859   of a page.
860 * `links` is only triggered by a change to the links of a page.
861   This includes when a link is added, removed, or changes what
862   it points to due to other changes. It does not include the
863   addition or removal of a duplicate link.
864
865 If multiple types are specified, they are combined.
866
867 ### `bestlink($$)`
868
869 Given a page and the text of a link on the page, determine which
870 existing page that link best points to. Prefers pages under a
871 subdirectory with the same name as the source page, failing that
872 goes down the directory tree to the base looking for matching
873 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
874
875 ### `htmllink($$$;@)`
876
877 Many plugins need to generate html links and add them to a page. This is
878 done by using the `htmllink` function. The usual way to call
879 `htmllink` is:
880
881         htmllink($page, $page, $link)
882
883 Why is `$page` repeated? Because if a page is inlined inside another, and a
884 link is placed on it, the right way to make that link is actually:
885
886         htmllink($page, $destpage, $link)
887
888 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
889 some of the hook functions above; the ones that are not passed it are not used
890 during inlining and don't need to worry about this issue.
891
892 After the three required parameters, named parameters can be used to
893 control some options. These are:
894
895 * noimageinline - set to true to avoid turning links into inline html images
896 * forcesubpage  - set to force a link to a subpage
897 * linktext - set to force the link text to something
898 * anchor - set to make the link include an anchor
899 * rel - set to add a rel attribute to the link
900 * class - set to add a css class to the link
901 * title - set to add a title attribute to the link
902
903 ### `readfile($;$)`
904
905 Given a filename, reads and returns the entire file.
906
907 The optional second parameter, if set to a true value, makes the file be read
908 in binary mode.
909
910 A failure to read the file will result in it dying with an error.
911
912 ### `writefile($$$;$$)`
913
914 Given a filename, a directory to put it in, and the file's content,
915 writes a file. 
916
917 The optional fourth parameter, if set to a true value, makes the file be
918 written in binary mode.
919
920 The optional fifth parameter can be used to pass a function reference that
921 will be called to handle writing to the file. The function will be called
922 and passed a file descriptor it should write to, and an error recovery
923 function it should call if the writing fails. (You will not normally need to
924 use this interface.)
925
926 A failure to write the file will result in it dying with an error.
927
928 If the destination directory doesn't exist, it will first be created.
929
930 The filename and directory are separate parameters because of
931 some security checks done to avoid symlink attacks. Before writing a file,
932 it checks to make sure there's not a symlink with its name, to avoid
933 following the symlink. If the filename parameter includes a subdirectory
934 to put the file in, it also checks if that subdirectory is a symlink, etc.
935 The directory parameter, however, is not checked for symlinks. So,
936 generally the directory parameter is a trusted toplevel directory like
937 the srcdir or destdir, and any subdirectories of this are included in the
938 filename parameter.
939
940 ### `will_render($$)`
941
942 Given a page name and a destination file name (not including the base
943 destination directory), register that the page will result in that file
944 being rendered. 
945
946 It's important to call this before writing to any file in the destination
947 directory, and it's important to call it consistently every time, even if
948 the file isn't really written this time -- unless you delete any old
949 version of the file. In particular, in preview mode, this should still be
950 called even if the file isn't going to be written to during the preview.
951
952 Ikiwiki uses this information to automatically clean up rendered files when
953 the page that rendered them goes away or is changed to no longer render
954 them. will_render also does a few important security checks.
955
956 ### `pagetype($)`
957
958 Given the name of a source file, returns the type of page it is, if it's
959 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
960
961 ### `pagename($)`
962
963 Given the name of a source file, returns the name of the wiki page
964 that corresponds to that file.
965
966 ### `pagetitle($)`
967
968 Give the name of a wiki page, returns a version suitable to be displayed as
969 the page's title. This is accomplished by de-escaping escaped characters in
970 the page name. "_" is replaced with a space, and '__NN__' is replaced by 
971 the UTF character with code NN.
972
973 ### `titlepage($)`
974
975 This performs the inverse of `pagetitle`, ie, it converts a page title into
976 a wiki page name.
977
978 ### `linkpage($)`
979
980 This converts text that could have been entered by the user as a
981 [[ikiwiki/WikiLink]] into a wiki page name.
982
983 ### `srcfile($;$)`
984
985 Given the name of a source file in the wiki, searches for the file in
986 the source directory and the underlay directories (most recently added
987 underlays first), and returns the full path to the first file found.
988
989 Normally srcfile will fail with an error message if the source file cannot
990 be found. The second parameter can be set to a true value to make it return
991 undef instead.
992
993 ### `add_underlay($)`
994
995 Adds a directory to the set of underlay directories that ikiwiki will
996 search for files.
997
998 If the directory name is not absolute, ikiwiki will assume it is in
999 the parent directory of the configured underlaydir.
1000
1001 ### `displaytime($;$$)`
1002
1003 Given a time, formats it for display.
1004
1005 The optional second parameter is a strftime format to use to format the
1006 time.
1007
1008 If the third parameter is true, this is the publication time of a page.
1009 (Ie, set the html5 pubdate attribute.)
1010
1011 ### `gettext`
1012
1013 This is the standard gettext function, although slightly optimised.
1014
1015 ### `ngettext`
1016
1017 This is the standard ngettext function, although slightly optimised.
1018
1019 ### `urlto($;$$)`
1020
1021 Construct a relative url to the first parameter from the page named by the
1022 second. The first parameter can be either a page name, or some other
1023 destination file, as registered by `will_render`.
1024
1025 Provide a second parameter whenever possible, since this leads to better
1026 behaviour for the [[plugins/po]] plugin and `file:///` URLs.
1027
1028 If the second parameter is not specified (or `undef`), the URL will be
1029 valid from any page on the wiki, or from the CGI; if possible it'll
1030 be a path starting with `/`, but an absolute URL will be used if
1031 the wiki and the CGI are on different domains.
1032
1033 If the third parameter is passed and is true, the url will be a fully
1034 absolute url. This is useful when generating an url to publish elsewhere.
1035
1036 ### `newpagefile($$)`
1037
1038 This can be called when creating a new page, to determine what filename
1039 to save the page to. It's passed a page name, and its type, and returns
1040 the name of the file to create, relative to the srcdir.
1041
1042 ### `targetpage($$;$)`
1043
1044 Passed a page and an extension, returns the filename that page will be
1045 rendered to.
1046
1047 Optionally, a third parameter can be passed, to specify the preferred
1048 filename of the page. For example, `targetpage("foo", "rss", "feed")`
1049 will yield something like `foo/feed.rss`.
1050
1051 ### `add_link($$;$)`
1052
1053 This adds a link to `%links`, ensuring that duplicate links are not
1054 added. Pass it the page that contains the link, and the link text.
1055
1056 An optional third parameter sets the link type. If not specified,
1057 it is an ordinary [[ikiwiki/WikiLink]].
1058
1059 ### `add_autofile($$$)`
1060
1061 Sometimes you may want to add a file to the `srcdir` as a result of content
1062 of other pages. For example, [[plugins/tag]] pages can be automatically
1063 created as needed. This function can be used to do that. 
1064
1065 The three parameters are the filename to create (relative to the `srcdir`),
1066 the name of the plugin, and a callback function. The callback will be
1067 called if it is appropriate to automatically add the file, and should then
1068 take care of creating it, and doing anything else it needs to (such as
1069 checking it into revision control). Note that the callback may not always
1070 be called. For example, if an automatically added file is deleted by the
1071 user, ikiwiki will avoid re-adding it again.
1072
1073 This function needs to be called during the scan hook, or earlier in the
1074 build process, in order to add the file early enough for it to be built.
1075
1076 ## Miscellaneous
1077
1078 ### Internal use pages
1079
1080 Sometimes it's useful to put pages in the wiki without the overhead of
1081 having them be rendered to individual html files. Such internal use pages
1082 are collected together to form the RecentChanges page, for example.
1083
1084 To make an internal use page, register a filename extension that starts
1085 with "_". Internal use pages cannot be edited with the web interface,
1086 generally shouldn't contain [[WikiLinks|ikiwiki/WikiLink]] or preprocessor directives (use
1087 either on them with extreme caution), and are not matched by regular
1088 PageSpecs glob patterns, but instead only by a special `internal()`
1089 [[ikiwiki/PageSpec]].
1090
1091 ### RCS plugins
1092
1093 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
1094 plugins. See [[RCS_details|rcs/details]] for some more info.
1095
1096 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
1097 and the 'id' field is set to the name of the hook. For example:
1098         
1099         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
1100         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
1101
1102 #### `rcs_update()`
1103
1104 Updates the working directory with any remote changes.
1105
1106 #### `rcs_prepedit($)`
1107
1108 Is passed a file to prepare to edit. It can generate and return an arbitrary
1109 token, that will be passed into `rcs_commit` when committing. For example,
1110 it might return the current revision ID of the file, and use that
1111 information later when merging changes.
1112
1113 #### `rcs_commit(@)`
1114
1115 Passed named parameters: `file`, `message`, `token` (from `rcs_prepedit`),
1116 and `session` (optional).
1117
1118 Should try to commit the file. Returns `undef` on *success* and a version
1119 of the page with the rcs's conflict markers on failure.
1120
1121 #### `rcs_commit_staged(@)`
1122
1123 Passed named parameters: `message`, and `session` (optional).
1124
1125 Should commit all staged changes. Returns undef on success, and an
1126 error message on failure.
1127
1128 Changes can be staged by calls to `rcs_add`, `rcs_remove`, and
1129 `rcs_rename`.
1130
1131 #### `rcs_add($)`
1132
1133 Adds the passed file to the archive. The filename is relative to the root
1134 of the srcdir.
1135
1136 Note that this should not commit the new file, it should only
1137 prepare for it to be committed when rcs_commit (or `rcs_commit_staged`) is
1138 called. Note that the file may be in a new subdir that is not yet in
1139 to version control; the subdir can be added if so.
1140
1141 #### `rcs_remove($)`
1142
1143 Remove a file. The filename is relative to the root of the srcdir.
1144
1145 Note that this should not commit the removal, it should only prepare for it
1146 to be committed when `rcs_commit` (or `rcs_commit_staged`) is called.
1147
1148 #### `rcs_rename($$)`
1149
1150 Rename a file. The filenames are relative to the root of the srcdir.
1151
1152 Note that this should not commit the rename, it should only
1153 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
1154 The new filename may be in a new subdir, that is not yet added to
1155 version control. If so, the subdir will exist already, and should
1156 be added to revision control.
1157
1158 #### `rcs_recentchanges($)`
1159
1160 Examine the RCS history and generate a list of recent changes.
1161 The parameter is how many changes to return.
1162
1163 The data structure returned for each change is:
1164
1165         {
1166                 rev => # the RCSs id for this commit
1167                 user => # user who made the change (may be an openid),
1168                 nickname => # short name for user (optional; not an openid),
1169                 
1170                 committype => # either "web" or the name of the rcs,
1171                 when => # time when the change was made,
1172                 message => [
1173                         { line => "commit message line 1" },
1174                         { line => "commit message line 2" },
1175                         # etc,
1176                 ],
1177                 pages => [
1178                         {
1179                                 page => # name of page changed,
1180                                 diffurl => # optional url to a diff of changes
1181                         },
1182                         # repeat for each page changed in this commit,
1183                 ],
1184         }
1185
1186 #### `rcs_diff($;$)`
1187
1188 The first parameter is the rev from `rcs_recentchanges`.
1189 The optional second parameter is how many lines to return (default: all).
1190
1191 Should return a list of lines of the diff (including \n) in list
1192 context, and a string containing the whole diff in scalar context.
1193
1194 #### `rcs_getctime($)`
1195
1196 This is used to get the page creation time for a file from the RCS, by looking
1197 it up in the history.
1198
1199 If the RCS cannot determine a ctime for the file, return 0.
1200
1201 #### `rcs_getmtime($)`
1202
1203 This is used to get the page modification time for a file from the RCS, by
1204 looking it up in the history.
1205
1206 It's ok if this is not implemented, and throws an error.
1207
1208 If the RCS cannot determine a mtime for the file, return 0.
1209
1210 #### `rcs_receive()`
1211
1212 This is called when ikiwiki is running as a pre-receive hook (or
1213 equivalent), and is testing if changes pushed into the RCS from an
1214 untrusted user should be accepted. This is optional, and doesn't make
1215 sense to implement for all RCSs.
1216
1217 It should examine the incoming changes, and do any sanity 
1218 checks that are appropriate for the RCS to limit changes to safe file adds,
1219 removes, and changes. If something bad is found, it should die, to abort
1220 the push. Otherwise, it should return a list of files that were changed,
1221 in the form:
1222
1223         {
1224                 file => # name of file that was changed
1225                 action => # either "add", "change", or "remove"
1226                 path => # temp file containing the new file content, only
1227                         # needed for "add"/"change", and only if the file
1228                         # is an attachment, not a page
1229         }
1230
1231 The list will then be checked to make sure that each change is one that
1232 is allowed to be made via the web interface.
1233
1234 #### `rcs_preprevert($)`
1235
1236 This is called by the revert web interface. It is passed a RCS-specific
1237 change ID, and should determine what the effects would be of reverting
1238 that change, and return the same data structure as `rcs_receive`.
1239
1240 Like `rcs_receive`, it should do whatever sanity checks are appropriate
1241 for the RCS to limit changes to safe changes, and die if a change would
1242 be unsafe to revert.
1243
1244 #### `rcs_revert($)`
1245
1246 This is called by the revert web interface. It is passed a named
1247 parameter rev that is the RCS-specific change ID to revert.
1248
1249 It should try to revert the specified rev, and leave the reversion staged
1250 so `rcs_commit_staged` will complete it. It should return undef on _success_
1251 and an error message on failure.
1252
1253 This hook and `rcs_preprevert` are optional, if not implemented, no revert
1254 web interface will be available.
1255
1256 ### PageSpec plugins
1257
1258 It's also possible to write plugins that add new functions to
1259 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
1260 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
1261 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
1262 two parameters: The name of the page being matched, and the thing to match
1263 against. It may also be passed additional, named parameters.
1264
1265 It should return a IkiWiki::SuccessReason object if the match succeeds, or
1266 an IkiWiki::FailReason object if the match fails. If the match cannot be
1267 attempted at all, for any page, it can instead return an
1268 IkiWiki::ErrorReason object explaining why.
1269
1270 When constructing these objects, you should also include information about
1271 of any pages whose contents or other metadata influenced the result of the
1272 match. Do this by passing a list of pages, followed by `deptype` values.
1273
1274 For example, "backlink(foo)" is influenced by the contents of page foo;
1275 "link(foo)" and "title(bar)" are influenced by the contents of any page
1276 they match; "created_before(foo)" is influenced by the metadata of foo;
1277 while "glob(*)" is not influenced by the contents of any page.
1278
1279 ### Sorting plugins
1280
1281 Similarly, it's possible to write plugins that add new functions as
1282 [[ikiwiki/pagespec/sorting]] methods. To achieve this, add a function to
1283 the IkiWiki::SortSpec package named `cmp_foo`, which will be used when sorting
1284 by `foo` or `foo(...)` is requested.
1285
1286 The names of pages to be compared are in the global variables `$a` and `$b`
1287 in the IkiWiki::SortSpec package. The function should return the same thing
1288 as Perl's `cmp` and `<=>` operators: negative if `$a` is less than `$b`,
1289 positive if `$a` is greater, or zero if they are considered equal. It may
1290 also raise an error using `error`, for instance if it needs a parameter but
1291 one isn't provided.
1292
1293 The function will also be passed one or more parameters. The first is
1294 `undef` if invoked as `foo`, or the parameter `"bar"` if invoked as `foo(bar)`;
1295 it may also be passed additional, named parameters.
1296
1297 ### Setup plugins
1298
1299 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
1300 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
1301 and the rest of the file is passed to that module's import method.
1302
1303 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
1304 can be used to configure ikiwiki in different ways. These modules should,
1305 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
1306 to a hash containing all the config items. They should also implement a
1307 `gendump` function.
1308
1309 By the way, to parse a ikiwiki setup file and populate `%config`, a
1310 program just needs to do something like:
1311 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`
1312
1313 ### Function overriding
1314
1315 Sometimes using ikiwiki's pre-defined hooks is not enough. Your plugin
1316 may need to replace one of ikiwiki's own functions with a modified version,
1317 or wrap one of the functions.
1318
1319 For example, your plugin might want to override `displaytime`, to change
1320 the html markup used when displaying a date. Or it might want to override
1321 `IkiWiki::formattime`, to change how a date is formatted. Or perhaps you
1322 want to override `bestlink` and change how ikiwiki deals with [[WikiLinks|ikiwiki/WikiLink]].
1323
1324 By venturing into this territory, your plugin is becoming tightly tied to
1325 ikiwiki's internals. And it might break if those internals change. But
1326 don't let that stop you, if you're brave.
1327
1328 Ikiwiki provides an `inject()` function, that is a powerful way to replace
1329 any function with one of your own. This even allows you to inject a
1330 replacement for an exported function, like `bestlink`. Everything that
1331 imports that function will get your version instead. Pass it the name of
1332 the function to replace, and a new function to call. 
1333
1334 For example, here's how to replace `displaytime` with a version using HTML 5
1335 markup:
1336
1337         inject(name => 'IkiWiki::displaytime', call => sub {
1338                 return "<time>".formattime(@_)."</time>";
1339         });
1340
1341 Here's how to wrap `bestlink` with a version that tries to handle
1342 plural words:
1343
1344         my $origbestlink=\&bestlink;
1345         inject(name => 'IkiWiki::bestlink', call => \&mybestlink);
1346
1347         sub deplural ($) {
1348                 my $word=shift;
1349                 $word =~ s/e?s$//; # just an example :-)
1350                 return $word;
1351         }
1352
1353         sub mybestlink ($$) {
1354                 my $page=shift;
1355                 my $link=shift;
1356                 my $ret=$origbestlink->($page, $link);
1357                 if (! length $ret) {
1358                         $ret=$origbestlink->($page, deplural($link));
1359                 }
1360                 return $ret;
1361         }
1362
1363 ### Javascript
1364
1365 Some plugins use javascript to make ikiwiki look a bit more web-2.0-ish.
1366
1367 All javascript code should be put in `.js` files in the `javascript`
1368 underlay, and plugins using those files can enable use of the underlay by
1369 calling `add_underlay("javascript");` in their `import` function.
1370
1371 You'll have to arrange for `<script>` tags to be added to the pages that
1372 use your javascript. This can be done using a `format` hook.
1373
1374 Ikiwiki provides some utility functions in `ikiwiki.js`, for use by other
1375 javascript code. These include:
1376
1377 #### `getElementsByClass(cls, node, tag)` 
1378
1379 Returns an array of elements with the given class. The node and tag are
1380 optional and define what document node and element names to search.
1381
1382 #### `hook(name, call)`
1383
1384 The function `call` will be run as part of the hook named `name`.
1385
1386 Note that to hook into `window.onload`, you can use the `onload' hook.
1387
1388 #### `run_hooks(name)`
1389
1390 Runs the hooks with the specified name.