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