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