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