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