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