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