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