]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/write.mdwn
Merge commit 'upstream/master' into prv/po
[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 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. 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 => \&canedit);
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 ### cansave
325
326         hook(type => "cansave", id => "foo", call => \&cansave);
327
328 This hook can be used to implement arbitrary access methods to control
329 when a page being edited can be saved using the web interface (commits
330 from revision control bypass it).
331
332 When a page is about to be saved, each registered cansave hook is
333 called in turn, and passed the page name, the edited content, a CGI
334 object and a session object.
335
336 The return value of a cansave hook is interpreted the same as for the
337 canedit hook.
338
339 ### canremove
340
341         hook(type => "canremove", id => "foo", call => \&canremove);
342
343 This hook can be used to implement arbitrary access methods to control when
344 a page can be removed using the web interface (commits from revision control
345 bypass it). It works exactly like the `canedit` hook.
346
347 ### canrename
348
349         hook(type => "canrename", id => "foo", call => \&canrename);
350
351 This hook can be used to implement arbitrary access methods to control when
352 a page can be renamed using the web interface (commits from revision control
353 bypass it). It works exactly like the `canedit` and `canremove` hook,
354 but is passed:
355 * a CGI object
356 * a session object
357 * the named parameters `src`, `srcfile`, `dest` and `destfile`.
358
359 ### checkcontent
360         
361         hook(type => "checkcontent", id => "foo", call => \&checkcontent);
362
363 This hook is called to check the content a user has entered on a page,
364 before it is saved, and decide if it should be allowed.
365
366 It is passed named parameters: `content`, `page`, `cgi`, and `session`. If
367 the content the user has entered is a comment, it may also be passed some
368 additional parameters: `author`, `url`, and `subject`. The `subject`
369 parameter may also be filled with the user's comment about the change.
370
371 Note: When the user edits an existing wiki page, the passed `content` will
372 include only the lines that they added to the page, or modified.
373
374 The hook should return `undef` on success. If the content is disallowed, it
375 should return a message stating what the problem is, or a function
376 that can be run to perform whatever action is necessary to allow the user
377 to post the content.
378
379 ### editcontent
380
381         hook(type => "editcontent", id => "foo", call => \&editcontent);
382
383 This hook is called when a page is saved (or previewed) using the web
384 interface. It is passed named parameters: `content`, `page`, `cgi`, and
385 `session`. These are, respectively, the new page content as entered by the
386 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
387
388 It can modify the content as desired, and should return the content.
389
390 ### formbuilder
391
392         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
393         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
394
395 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
396 CGI::FormBuilder]] to generate web forms. These hooks are passed named
397 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
398 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
399 reference to an array of names of buttons to go on the form.
400
401 Each time a form is set up, the `formbuilder_setup` hook is called.
402 Typically the `formbuilder_setup` hook will check the form's title, and if
403 it's a form that it needs to modify, will call various methods to
404 add/remove/change fields, tweak the validation code for the fields, etc. It
405 will not validate or display the form.
406
407 Just before a form is displayed to the user, the `formbuilder` hook is
408 called. It can be used to validate the form, but should not display it.
409
410 ### savestate
411
412         hook(type => "savestate", id => "foo", call => \&savestate);
413
414 This hook is called whenever ikiwiki normally saves its state, just before
415 the state is saved. The function can save other state, modify values before
416 they're saved, etc.
417
418 ### renamelink
419
420         hook(type => "renamelink", id => "foo", call => \&renamelink);
421
422 This hook is called by the [[plugins/rename]] plugin when it renames
423 something, once per page linking to the renamed page's old location.
424 The hook is passed named parameters: `page`, `oldpage`, `newpage`, and
425 `content`, and should try to modify the content of `page` to reflect
426 the name change. For example, by converting links to point to the
427 new page.
428
429 ### rename
430
431         hook(type => "rename", id => "foo", call => \&renamepages);
432
433 When a page or set of pages is renamed, the referenced function is
434 called, and is passed:
435
436 * a reference to an array of hashes with keys: `src`, `srcfile`,
437   `dest`, `destfile`, `required`. Such a hook function can modify
438   the array.
439 * a CGI object
440 * a session object
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                         option_foo => {
461                                 type => "boolean",
462                                 description => "enable foo?",
463                                 advanced => 1,
464                                 safe => 1,
465                                 rebuild => 1,
466                         },
467                         option_bar => {
468                                 type => "string",
469                                 example => "hello",
470                                 description => "option bar",
471                                 safe => 1,
472                                 rebuild => 0,
473                         },
474                         plugin => {
475                                 description => "description of this plugin",
476                                 safe => 1,
477                                 rebuild => 1,
478                         },
479
480 * `type` can be "boolean", "string", "integer", "pagespec",
481   or "internal" (used for values that are not user-visible). The type is
482   the type of the leaf values;  the `%config` option may be an array or
483   hash of these.
484 * `example` can be set to an example value.
485 * `description` is a short description of the option.
486 * `link` is a link to further information about the option. This can either
487   be a wikilink, or an url.
488 * `advanced` can be set to true if the option is more suitable for advanced
489   users.
490 * `safe` should be false if the option should not be displayed in unsafe
491   configuration methods, such as the web interface. Anything that specifies
492   a command to run, a path on disk, or a regexp should be marked as unsafe.
493   If a plugin is marked as unsafe, that prevents it from being
494   enabled/disabled.
495 * `rebuild` should be true if changing the option (or enabling/disabling
496   the plugin) will require a wiki rebuild, false if no rebuild is needed,
497   and undef if a rebuild could be needed in some circumstances, but is not
498   strictly required.
499
500 ## Plugin interface
501
502 To import the ikiwiki plugin interface:
503
504         use IkiWiki '3.00';
505
506 This will import several variables and functions into your plugin's
507 namespace. These variables and functions are the ones most plugins need,
508 and a special effort will be made to avoid changing them in incompatible
509 ways, and to document any changes that have to be made in the future.
510
511 Note that IkiWiki also provides other variables and functions that are not
512 exported by default. No guarantee is made about these in the future, so if
513 it's not exported, the wise choice is to not use it.
514
515 ### %config
516
517 A plugin can access the wiki's configuration via the `%config`
518 hash. The best way to understand the contents of the hash is to look at
519 your ikiwiki setup file, which sets the hash content to configure the wiki.
520
521 ### %pagestate
522
523 The `%pagestate` hash can be used by plugins to save state that they will need
524 next time ikiwiki is run. The hash holds per-page state, so to set a value,
525 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
526 use `$pagestate{$page}{$id}{$key}`.
527
528 The `$value` can be anything that perl's Storable module is capable of
529 serializing. `$key` can be any string you like, but `$id` must be the same
530 as the "id" parameter passed to `hook()` when registering the plugin. This
531 is so ikiwiki can know when to delete pagestate for plugins that are no
532 longer used.
533
534 When pages are deleted, ikiwiki automatically deletes their pagestate too.
535
536 Note that page state does not persist across wiki rebuilds, only across
537 wiki updates.
538
539 ### %wikistate
540
541 The `%wikistate` hash can be used by a plugin to store persistant state
542 that is not bound to any one page. To set a value, use
543 `$wikistate{$id}{$key}=$value, where `$value` is anything Storable can
544 serialize, `$key` is any string you like, and `$id` must be the same as the
545 "id" parameter passed to `hook()` when registering the plugin, so that the
546 state can be dropped if the plugin is no longer used.
547
548 ### Other variables
549
550 If your plugin needs to access data about other pages in the wiki. It can
551 use the following hashes, using a page name as the key:
552
553 * `%links` lists the names of each page that a page links to, in an array
554   reference.
555 * `%destsources` contains the name of the source file used to create each
556   destination file.
557 * `%pagesources` contains the name of the source file for each page.
558
559 Also, the `%IkiWiki::version` variable contains the version number for the
560 ikiwiki program.
561
562 ### Library functions
563
564 #### `hook(@)`
565
566 Hook into ikiwiki's processing. See the discussion of hooks above.
567
568 Note that in addition to the named parameters described above, a parameter
569 named `no_override` is supported, If it's set to a true value, then this hook
570 will not override any existing hook with the same id. This is useful if
571 the id can be controled by the user.
572
573 #### `debug($)`
574
575 Logs a debugging message. These are supressed unless verbose mode is turned
576 on.
577
578 #### `warning($)`
579
580 Logs a warning message.
581
582 #### `error($;$)`
583
584 Aborts with an error message. If the second parameter is passed, it is a
585 function that is called after the error message is printed, to do any final
586 cleanup.
587
588 If called inside a preprocess hook, error() does not abort the entire
589 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
590 a version containing the error message.
591
592 In other hooks, error() is a fatal error, so use with care. Try to avoid
593 dying on bad input when building a page, as that will halt
594 the entire wiki build and make the wiki unusable.
595
596 #### `template($;@)`
597
598 Creates and returns a [[!cpan HTML::Template]] object. The first parameter
599 is the name of the file in the template directory. The optional remaining
600 parameters are passed to `HTML::Template->new`.
601
602 #### `htmlpage($)`
603
604 Passed a page name, returns the base name that will be used for a the html
605 page created from it. (Ie, it appends ".html".)
606
607 Use this when constructing the filename of a html file. Use `urlto` when
608 generating a link to a page.
609
610 #### `add_depends($$)`
611
612 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
613
614 #### `pagespec_match($$;@)`
615
616 Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
617 [[ikiwiki/PageSpec]] matches the page.
618
619 Additional named parameters can be passed, to further limit the match.
620 The most often used is "location", which specifies the location the
621 PageSpec should match against. If not passed, relative PageSpecs will match
622 relative to the top of the wiki.
623
624 #### `bestlink($$)`
625
626 Given a page and the text of a link on the page, determine which
627 existing page that link best points to. Prefers pages under a
628 subdirectory with the same name as the source page, failing that
629 goes down the directory tree to the base looking for matching
630 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
631
632 #### `htmllink($$$;@)`
633
634 Many plugins need to generate html links and add them to a page. This is
635 done by using the `htmllink` function. The usual way to call
636 `htmlllink` is:
637
638         htmllink($page, $page, $link)
639
640 Why is `$page` repeated? Because if a page is inlined inside another, and a
641 link is placed on it, the right way to make that link is actually:
642
643         htmllink($page, $destpage, $link)
644
645 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
646 some of the hook functions above; the ones that are not passed it are not used
647 during inlining and don't need to worry about this issue.
648
649 After the three required parameters, named parameters can be used to
650 control some options. These are:
651
652 * noimageinline - set to true to avoid turning links into inline html images
653 * forcesubpage  - set to force a link to a subpage
654 * linktext - set to force the link text to something
655 * anchor - set to make the link include an anchor
656 * rel - set to add a rel attribute to the link
657 * class - set to add a css class to the link
658
659 #### `readfile($;$)`
660
661 Given a filename, reads and returns the entire file.
662
663 The optional second parameter, if set to a true value, makes the file be read
664 in binary mode.
665
666 A failure to read the file will result in it dying with an error.
667
668 #### `writefile($$$;$$)`
669
670 Given a filename, a directory to put it in, and the file's content,
671 writes a file. 
672
673 The optional fourth parameter, if set to a true value, makes the file be
674 written in binary mode.
675
676 The optional fifth parameter can be used to pass a function reference that
677 will be called to handle writing to the file. The function will be called
678 and passed a file descriptor it should write to, and an error recovery
679 function it should call if the writing fails. (You will not normally need to
680 use this interface.)
681
682 A failure to write the file will result in it dying with an error.
683
684 If the destination directory doesn't exist, it will first be created.
685
686 #### `will_render($$)`
687
688 Given a page name and a destination file name (not including the base
689 destination directory), register that the page will result in that file
690 being rendered. 
691
692 It's important to call this before writing to any file in the destination
693 directory, and it's important to call it consistently every time, even if
694 the file isn't really written this time -- unless you delete any old
695 version of the file. In particular, in preview mode, this should still be
696 called even if the file isn't going to be written to during the preview.
697
698 Ikiwiki uses this information to automatically clean up rendered files when
699 the page that rendered them goes away or is changed to no longer render
700 them. will_render also does a few important security checks.
701
702 #### `pagetype($)`
703
704 Given the name of a source file, returns the type of page it is, if it's
705 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
706
707 #### `pagename($)`
708
709 Given the name of a source file, returns the name of the wiki page
710 that corresponds to that file.
711
712 #### `pagetitle($)`
713
714 Give the name of a wiki page, returns a version suitable to be displayed as
715 the page's title. This is accomplished by de-escaping escaped characters in
716 the page name. "_" is replaced with a space, and '__NN__' is replaced by 
717 the UTF character with code NN.
718
719 #### `titlepage($)`
720
721 This performs the inverse of `pagetitle`, ie, it converts a page title into
722 a wiki page name.
723
724 #### `linkpage($)`
725
726 This converts text that could have been entered by the user as a
727 [[WikiLink]] into a wiki page name.
728
729 #### `srcfile($;$)`
730
731 Given the name of a source file in the wiki, searches for the file in
732 the source directory and the underlay directories (most recently added
733 underlays first), and returns the full path to the first file found.
734
735 Normally srcfile will fail with an error message if the source file cannot
736 be found. The second parameter can be set to a true value to make it return
737 undef instead.
738
739 #### `add_underlay($)`
740
741 Adds a directory to the set of underlay directories that ikiwiki will
742 search for files.
743
744 If the directory name is not absolute, ikiwiki will assume it is in
745 the parent directory of the configured underlaydir.
746
747 #### `displaytime($;$)`
748
749 Given a time, formats it for display.
750
751 The optional second parameter is a strftime format to use to format the
752 time.
753
754 #### `gettext`
755
756 This is the standard gettext function, although slightly optimised.
757
758 #### `urlto($$;$)`
759
760 Construct a relative url to the first parameter from the page named by the
761 second. The first parameter can be either a page name, or some other
762 destination file, as registered by `will_render`.
763
764 If the third parameter is passed and is true, an absolute url will be
765 constructed instead of the default relative url.
766
767 #### `newpagefile($$)`
768
769 This can be called when creating a new page, to determine what filename
770 to save the page to. It's passed a page name, and its type, and returns
771 the name of the file to create, relative to the srcdir.
772
773 #### `targetpage($$;$)`
774
775 Passed a page and an extension, returns the filename that page will be
776 rendered to.
777
778 Optionally, a third parameter can be passed, to specify the preferred
779 filename of the page. For example, `targetpage("foo", "rss", "feed")`
780 will yield something like `foo/feed.rss`.
781
782 ## Miscellaneous
783
784 ### Internal use pages
785
786 Sometimes it's useful to put pages in the wiki without the overhead of
787 having them be rendered to individual html files. Such internal use pages
788 are collected together to form the RecentChanges page, for example.
789
790 To make an internal use page, register a filename extension that starts
791 with "_". Internal use pages cannot be edited with the web interface,
792 generally shouldn't contain wikilinks or preprocessor directives (use
793 either on them with extreme caution), and are not matched by regular
794 PageSpecs glob patterns, but instead only by a special `internal()`
795 [[ikiwiki/PageSpec]].
796
797 ### RCS plugins
798
799 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
800 plugins. See [[RCS_details|rcs/details]] for some more info.
801
802 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
803 and the 'id' field is set to the name of the hook. For example:
804         
805         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
806         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
807
808 #### `rcs_update()`
809
810 Updates the working directory with any remote changes.
811
812 #### `rcs_prepedit($)`
813
814 Is passed a file to prepare to edit. It can generate and return an arbitrary
815 token, that will be passed into `rcs_commit` when committing. For example,
816 it might return the current revision ID of the file, and use that
817 information later when merging changes.
818
819 #### `rcs_commit($$$;$$)`
820
821 Passed a file, message, token (from `rcs_prepedit`), user, and ip address.
822 Should try to commit the file. Returns `undef` on *success* and a version
823 of the page with the rcs's conflict markers on failure.
824
825 #### `rcs_commit_staged($$$)`
826
827 Passed a message, user, and ip address. Should commit all staged changes.
828 Returns undef on success, and an error message on failure.
829
830 Changes can be staged by calls to `rcs_add, `rcs_remove`, and
831 `rcs_rename`.
832
833 #### `rcs_add($)`
834
835 Adds the passed file to the archive. The filename is relative to the root
836 of the srcdir.
837
838 Note that this should not commit the new file, it should only
839 prepare for it to be committed when rcs_commit (or `rcs_commit_staged`) is
840 called. Note that the file may be in a new subdir that is not yet in
841 to version control; the subdir can be added if so.
842
843 #### `rcs_remove($)`
844
845 Remove a file. The filename is relative to the root of the srcdir.
846
847 Note that this should not commit the removal, it should only prepare for it
848 to be committed when `rcs_commit` (or `rcs_commit_staged`) is called. Note
849 that the new file may be in a new subdir that is not yet in version
850 control; the subdir can be added if so.
851
852 #### `rcs_rename($$)`
853
854 Rename a file. The filenames are relative to the root of the srcdir.
855
856 Note that this should not commit the rename, it should only
857 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
858 The new filename may be in a new subdir, that is not yet added to
859 version control. If so, the subdir will exist already, and should
860 be added to revision control.
861
862 #### `rcs_recentchanges($)`
863
864 Examine the RCS history and generate a list of recent changes.
865 The parameter is how many changes to return.
866
867 The data structure returned for each change is:
868
869         {
870                 rev => # the RCSs id for this commit
871                 user => # name of user who made the change,
872                 committype => # either "web" or the name of the rcs,
873                 when => # time when the change was made,
874                 message => [
875                         { line => "commit message line 1" },
876                         { line => "commit message line 2" },
877                         # etc,
878                 ],
879                 pages => [
880                         {
881                                 page => # name of page changed,
882                                 diffurl => # optional url to a diff of changes
883                         },
884                         # repeat for each page changed in this commit,
885                 ],
886         }
887
888 #### `rcs_diff($)`
889
890 The parameter is the rev from `rcs_recentchanges`.
891 Should return a list of lines of the diff (including \n) in list
892 context, and the whole diff in scalar context.
893
894 #### `rcs_getctime($)`
895
896 This is used to get the page creation time for a file from the RCS, by looking
897 it up in the history.
898
899 It's ok if this is not implemented, and throws an error.
900
901 #### `rcs_receive()`
902
903 This is called when ikiwiki is running as a pre-receive hook (or
904 equivalent), and is testing if changes pushed into the RCS from an
905 untrusted user should be accepted. This is optional, and doesn't make
906 sense to implement for all RCSs.
907
908 It should examine the incoming changes, and do any sanity 
909 checks that are appropriate for the RCS to limit changes to safe file adds,
910 removes, and changes. If something bad is found, it should exit
911 nonzero, to abort the push. Otherwise, it should return a list of
912 files that were changed, in the form:
913
914         {
915                 file => # name of file that was changed
916                 action => # either "add", "change", or "remove"
917                 path => # temp file containing the new file content, only
918                         # needed for "add"/"change", and only if the file
919                         # is an attachment, not a page
920         }
921
922 The list will then be checked to make sure that each change is one that
923 is allowed to be made via the web interface.
924
925 ### PageSpec plugins
926
927 It's also possible to write plugins that add new functions to
928 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
929 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
930 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
931 two parameters: The name of the page being matched, and the thing to match
932 against. It may also be passed additional, named parameters. It should return
933 a IkiWiki::SuccessReason object if the match succeeds, or an
934 IkiWiki::FailReason object if the match fails.
935
936 ### Setup plugins
937
938 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
939 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
940 and the rest of the file is passed to that module's import method.
941
942 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
943 can be used to configure ikiwiki in different ways. These modules should,
944 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
945 to a hash containing all the config items. They should also implement a
946 `gendump` function.
947
948 By the way, to parse a ikiwiki setup file and populate `%config`, a
949 program just needs to do something like:
950 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`
951
952 ### Function overriding
953
954 Sometimes using ikiwiki's pre-defined hooks is not enough. Your plugin
955 may need to replace one of ikiwiki's own functions with a modified version,
956 or wrap one of the functions.
957
958 For example, your plugin might want to override `displaytime`, to change
959 the html markup used when displaying a date. Or it might want to override
960 `IkiWiki::formattime`, to change how a date is formatted. Or perhaps you
961 want to override `bestlink` and change how ikiwiki deals with WikiLinks.
962
963 By venturing into this territory, your plugin is becoming tightly tied to
964 ikiwiki's internals. And it might break if those internals change. But
965 don't let that stop you, if you're brave.
966
967 Ikiwiki provides an `inject()` function, that is a powerful way to replace
968 any function with one of your own. This even allows you to inject a
969 replacement for an exported function, like `bestlink`. Everything that
970 imports that function will get your version instead. Pass it the name of
971 the function to replace, and a new function to call. 
972
973 For example, here's how to replace `displaytime` with a version using HTML 5
974 markup:
975
976         inject(name => 'IkiWiki::displaytime', call => sub {
977                 return "<time>".formattime(@_)."</time>";
978         });
979
980 Here's how to wrap `bestlink` with a version that tries to handle
981 plural words:
982
983         my $origbestlink=\&bestlink;
984         inject(name => 'IkiWiki::bestlink', call => \&mybestlink);
985
986         sub deplural ($) {
987                 my $word=shift;
988                 $word =~ s/e?s$//; # just an example :-)
989                 return $word;
990         }
991
992         sub mybestlink ($$) {
993                 my $page=shift;
994                 my $link=shift;
995                 my $ret=$origbestlink->($page, $link);
996                 if (! length $ret) {
997                         $ret=$origbestlink->($page, deplural($link));
998                 }
999                 return $ret;
1000         }
1001
1002 ### Javascript
1003
1004 Some plugins use javascript to make ikiwiki look a bit more web-2.0-ish.
1005
1006 All javascript code should be put in `.js` files in the `javascript`
1007 underlay, and plugins using those files can enable use of the underlay by
1008 calling `add_underlay("javascript");` in their `import` function.
1009
1010 You'll have to arrange for `<script>` tags to be added to the pages that
1011 use your javascript. This can be done using a `format` hook.
1012
1013 Ikiwiki provides some utility functions in `ikiwiki.js`, for use by other
1014 javascript code. These include:
1015
1016 #### `getElementsByClass(cls, node, tag)` 
1017
1018 Returns an array of elements with the given class. The node and tag are
1019 optional and define what document node and element names to search.
1020
1021 #### `hook(name, call)`
1022
1023 The function `call` will be run as part of the hook named `name`.
1024
1025 Note that to hook into `window.onload`, you can use the `onload' hook.
1026
1027 #### `run_hooks(name)`
1028
1029 Runs the hooks with the specified name.