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