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