920fb8797cfa4a1d09e0947e261dc7455f1f89c7
[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 ### pagetemplate
192
193         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
194
195
196 [[Templates|wikitemplates]] are filled out for many different things in
197 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
198 a cgi. This hook allows modifying the variables available on those
199 templates. The function is passed named parameters. The "page" and
200 "destpage" parameters are the same as for a preprocess hook. The "template"
201 parameter is a [[!cpan HTML::Template]] object that is the template that
202 will be used to generate the page. The function can manipulate that
203 template object.
204
205 The most common thing to do is probably to call `$template->param()` to add
206 a new custom parameter to the template.
207
208 ### templatefile
209
210         hook(type => "templatefile", id => "foo", call => \&templatefile);
211
212 This hook allows plugins to change the [[template|wikitemplates]] that is
213 used for a page in the wiki. The hook is passed a "page" parameter, and
214 should return the name of the template file to use, or undef if it doesn't
215 want to change the default ("page.tmpl"). Template files are looked for in
216 /usr/share/ikiwiki/templates by default.
217
218 ### sanitize
219
220         hook(type => "sanitize", id => "foo", call => \&sanitize);
221
222 Use this to implement html sanitization or anything else that needs to
223 modify the body of a page after it has been fully converted to html.
224
225 The function is passed named parameters: "page", "destpage", and "content",
226 and should return the sanitized content.
227
228 ### postscan
229
230         hook(type => "postscan", id => "foo", call => \&postscan);
231
232 This hook is called once the full page body is available (but before the
233 format hook). The most common use is to update search indexes. Added in
234 ikiwiki 2.54.
235
236 The function is passed named parameters "page" and "content". Its return
237 value is ignored.
238
239 ### format
240
241         hook(type => "format", id => "foo", call => \&format);
242
243 The difference between format and sanitize is that sanitize only acts on
244 the page body, while format can modify the entire html page including the
245 header and footer inserted by ikiwiki, the html document type, etc. (It
246 should not rely on always being passed the entire page, as it won't be
247 when the page is being previewed.)
248
249 The function is passed named parameters: "page" and "content", and 
250 should return the formatted content.
251
252 ### delete
253
254         hook(type => "delete", id => "foo", call => \&delete);
255
256 Each time a page or pages is removed from the wiki, the referenced function
257 is called, and passed the names of the source files that were removed.
258
259 ### change
260
261         hook(type => "change", id => "foo", call => \&render);
262
263 Each time ikiwiki renders a change or addition (but not deletion) to the
264 wiki, the referenced function is called, and passed the names of the
265 source files that were rendered.
266
267 ### cgi
268
269         hook(type => "cgi", id => "foo", call => \&cgi);
270
271 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
272 called in turn, and passed a CGI object. The hook should examine the
273 parameters, and if it will handle this CGI request, output a page
274 (including the http headers) and terminate the program.
275
276 Note that cgi hooks are called as early as possible, before any ikiwiki
277 state is loaded, and with no session information.
278
279 ### auth
280
281         hook(type => "auth", id => "foo", call => \&auth);
282
283 This hook can be used to implement an authentication method. When a user
284 needs to be authenticated, each registered auth hook is called in turn, and
285 passed a CGI object and a session object. 
286
287 If the hook is able to authenticate the user, it should set the session
288 object's "name" parameter to the authenticated user's name. Note that
289 if the name is set to the name of a user who is not registered,
290 a basic registration of the user will be automatically performed.
291
292 ### sessioncgi
293
294         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
295
296 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
297 is only run once a session object is available. It is passed both a CGI
298 object and a session object. To check if the user is in fact signed in, you
299 can check if the session object has a "name" parameter set.
300
301 ### canedit
302
303         hook(type => "canedit", id => "foo", call => \&pagelocked);
304
305 This hook can be used to implement arbitrary access methods to control when
306 a page can be edited using the web interface (commits from revision control
307 bypass it). When a page is edited, each registered canedit hook is called
308 in turn, and passed the page name, a CGI object, and a session object.
309
310 If the hook has no opinion about whether the edit can proceed, return
311 `undef`, and the next plugin will be asked to decide. If edit can proceed,
312 the hook should return "". If the edit is not allowed by this hook, the
313 hook should return an error message for the user to see, or a function 
314 that can be run to log the user in or perform other action necessary for
315 them to be able to edit the page.
316
317 This hook should avoid directly redirecting the user to a signin page,
318 since it's sometimes used to test to see which pages in a set of pages a
319 user can edit.
320
321 ### editcontent
322
323         hook(type => "editcontent", id => "foo", call => \&editcontent);
324
325 This hook is called when a page is saved (or previewed) using the web
326 interface. It is passed named parameters: `content`, `page`, `cgi`, and
327 `session`. These are, respectively, the new page content as entered by the
328 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
329
330 It can modify the content as desired, and should return the content.
331
332 ### formbuilder
333
334         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
335         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
336
337 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
338 CGI::FormBuilder]] to generate web forms. These hooks are passed named
339 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
340 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
341 reference to an array of names of buttons to go on the form.
342
343 Each time a form is set up, the `formbuilder_setup` hook is called.
344 Typically the `formbuilder_setup` hook will check the form's title, and if
345 it's a form that it needs to modify, will call various methods to
346 add/remove/change fields, tweak the validation code for the fields, etc. It
347 will not validate or display the form.
348
349 Just before a form is displayed to the user, the `formbuilder` hook is
350 called. It can be used to validate the form, but should not display it.
351
352 ### savestate
353
354         hook(type => "savestate", id => "foo", call => \&savestate);
355
356 This hook is called whenever ikiwiki normally saves its state, just before
357 the state is saved. The function can save other state, modify values before
358 they're saved, etc.
359
360 ### renamepage
361
362         hook(type => "renamepage", id => "foo", call => \&renamepage);
363
364 This hook is called by the [[plugins/rename]] plugin when it renames
365 something. The hook is passed named parameters: `page`, `oldpage`,
366 `newpage`, and `content`, and should try to modify the content to reflect
367 the name change. For example, by converting links to point to the new page.
368
369 ### getsetup
370
371         hook(type => "getsetup", id => "foo", call => \&getsetup);
372
373 This hooks is not called during normal operation, but only when setting up 
374 the wiki, or generating a setup file. Plugins can use this hook to add
375 configuration options.
376
377 The hook is passed no parameters. It returns data about the configuration
378 options added by the plugin. It can also check if the plugin is usable, and
379 die if not, which will cause the plugin to not be offered in the configuration
380 interface.
381
382 The data returned is a list of `%config` options, followed by a hash
383 describing the option. There can also be an item named "plugin", which
384 describes the plugin as a whole. For example:
385
386                 return
387                         option_foo => {
388                                 type => "boolean",
389                                 description => "enable foo?",
390                                 advanced => 1,
391                                 safe => 1,
392                                 rebuild => 1,
393                         },
394                         option_bar => {
395                                 type => "string",
396                                 example => "hello",
397                                 description => "option bar",
398                                 safe => 1,
399                                 rebuild => 0,
400                         },
401                         plugin => {
402                                 description => "description of this plugin",
403                                 safe => 1,
404                                 rebuild => 1,
405                         },
406
407 * `type` can be "boolean", "string", "integer", "pagespec",
408   or "internal" (used for values that are not user-visible). The type is
409   the type of the leaf values;  the `%config` option may be an array or
410   hash of these.
411 * `example` can be set to an example value.
412 * `description` is a short description of the option.
413 * `link` is a link to further information about the option. This can either
414   be a wikilink, or an url.
415 * `advanced` can be set to true if the option is more suitable for advanced
416   users.
417 * `safe` should be false if the option should not be displayed in unsafe
418   configuration methods, such as the web interface. Anything that specifies
419   a command to run, a path on disk, or a regexp should be marked as unsafe.
420   If a plugin is marked as unsafe, that prevents it from being
421   enabled/disabled.
422 * `rebuild` should be true if changing the option (or enabling/disabling
423   the plugin) will require a wiki rebuild, false if no rebuild is needed,
424   and undef if a rebuild could be needed in some circumstances, but is not
425   strictly required.
426
427 ## Plugin interface
428
429 To import the ikiwiki plugin interface:
430
431         use IkiWiki '2.00';
432
433 This will import several variables and functions into your plugin's
434 namespace. These variables and functions are the ones most plugins need,
435 and a special effort will be made to avoid changing them in incompatible
436 ways, and to document any changes that have to be made in the future.
437
438 Note that IkiWiki also provides other variables and functions that are not
439 exported by default. No guarantee is made about these in the future, so if
440 it's not exported, the wise choice is to not use it.
441
442 ### %config
443
444 A plugin can access the wiki's configuration via the `%config`
445 hash. The best way to understand the contents of the hash is to look at
446 your ikiwiki setup file, which sets the hash content to configure the wiki.
447
448 ### %pagestate
449
450 The `%pagestate` hash can be used by plugins to save state that they will need
451 next time ikiwiki is run. The hash holds per-page state, so to set a value,
452 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
453 use `$pagestate{$page}{$id}{$key}`.
454
455 The `$value` can be anything that perl's Storable module is capable of
456 serializing. `$key` can be any string you like, but `$id` must be the same
457 as the "id" parameter passed to `hook()` when registering the plugin. This
458 is so ikiwiki can know when to delete pagestate for plugins that are no
459 longer used.
460
461 When pages are deleted, ikiwiki automatically deletes their pagestate too.
462
463 Note that page state does not persist across wiki rebuilds, only across
464 wiki updates.
465
466 ### Other variables
467
468 If your plugin needs to access data about other pages in the wiki. It can
469 use the following hashes, using a page name as the key:
470
471 * `%links` lists the names of each page that a page links to, in an array
472   reference.
473 * `%destsources` contains the name of the source file used to create each
474   destination file.
475 * `%pagesources` contains the name of the source file for each page.
476
477 Also, the %IkiWiki::version variable contains the version number for the
478 ikiwiki program.
479
480 ### Library functions
481
482 #### `hook(@)`
483
484 Hook into ikiwiki's processing. See the discussion of hooks above.
485
486 Note that in addition to the named parameters described above, a parameter
487 named `no_override` is supported, If it's set to a true value, then this hook
488 will not override any existing hook with the same id. This is useful if
489 the id can be controled by the user.
490
491 #### `debug($)`
492
493 Logs a debugging message. These are supressed unless verbose mode is turned
494 on.
495
496 #### `error($;$)`
497
498 Aborts with an error message. If the second parameter is passed, it is a
499 function that is called after the error message is printed, to do any final
500 cleanup.
501
502 If called inside a preprocess hook, error() does not abort the entire
503 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
504 a version containing the error message.
505
506 In other hooks, error() is a fatal error, so use with care. Try to avoid
507 dying on bad input when building a page, as that will halt
508 the entire wiki build and make the wiki unusable.
509
510 #### `template($;@)`
511
512 Creates and returns a [[!cpan HTML::Template]] object. The first parameter
513 is the name of the file in the template directory. The optional remaining
514 parameters are passed to `HTML::Template->new`.
515
516 #### `htmlpage($)`
517
518 Passed a page name, returns the base name that will be used for a the html
519 page created from it. (Ie, it appends ".html".)
520
521 #### `add_depends($$)`
522
523 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
524
525 #### `pagespec_match($$;@)`
526
527 Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
528 [[ikiwiki/PageSpec]] matches the page.
529
530 Additional named parameters can be passed, to further limit the match.
531 The most often used is "location", which specifies the location the
532 PageSpec should match against. If not passed, relative PageSpecs will match
533 relative to the top of the wiki.
534
535 #### `bestlink($$)`
536
537 Given a page and the text of a link on the page, determine which
538 existing page that link best points to. Prefers pages under a
539 subdirectory with the same name as the source page, failing that
540 goes down the directory tree to the base looking for matching
541 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
542
543 #### `htmllink($$$;@)`
544
545 Many plugins need to generate html links and add them to a page. This is
546 done by using the `htmllink` function. The usual way to call
547 `htmlllink` is:
548
549         htmllink($page, $page, $link)
550
551 Why is `$page` repeated? Because if a page is inlined inside another, and a
552 link is placed on it, the right way to make that link is actually:
553
554         htmllink($page, $destpage, $link)
555
556 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
557 some of the hook functions above; the ones that are not passed it are not used
558 during inlining and don't need to worry about this issue.
559
560 After the three required parameters, named parameters can be used to
561 control some options. These are:
562
563 * noimageinline - set to true to avoid turning links into inline html images
564 * forcesubpage  - set to force a link to a subpage
565 * linktext - set to force the link text to something
566 * anchor - set to make the link include an anchor
567 * rel - set to add a rel attribute to the link
568 * class - set to add a css class to the link
569
570 #### `readfile($;$)`
571
572 Given a filename, reads and returns the entire file.
573
574 The optional second parameter, if set to a true value, makes the file be read
575 in binary mode.
576
577 A failure to read the file will result in it dying with an error.
578
579 #### `writefile($$$;$$)`
580
581 Given a filename, a directory to put it in, and the file's content,
582 writes a file. 
583
584 The optional fourth parameter, if set to a true value, makes the file be
585 written in binary mode.
586
587 The optional fifth parameter can be used to pass a function reference that
588 will be called to handle writing to the file. The function will be called
589 and passed a file descriptor it should write to, and an error recovery
590 function it should call if the writing fails. (You will not normally need to
591 use this interface.)
592
593 A failure to write the file will result in it dying with an error.
594
595 If the destination directory doesn't exist, it will first be created.
596
597 #### `will_render($$)`
598
599 Given a page name and a destination file name (not including the base
600 destination directory), register that the page will result in that file
601 being rendered. 
602
603 It's important to call this before writing to any file in the destination
604 directory, and it's important to call it consistently every time, even if
605 the file isn't really written this time -- unless you delete any old
606 version of the file. In particular, in preview mode, this should still be
607 called even if the file isn't going to be written to during the preview.
608
609 Ikiwiki uses this information to automatically clean up rendered files when
610 the page that rendered them goes away or is changed to no longer render
611 them. will_render also does a few important security checks.
612
613 #### `pagetype($)`
614
615 Given the name of a source file, returns the type of page it is, if it's
616 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
617
618 #### `pagename($)`
619
620 Given the name of a source file, returns the name of the wiki page
621 that corresponds to that file.
622
623 #### `srcfile($;$)`
624
625 Given the name of a source file in the wiki, searches for the file in
626 the source directory and the underlay directories (most recently added
627 underlays first), and returns the full path to the first file found.
628
629 Normally srcfile will fail with an error message if the source file cannot
630 be found. The second parameter can be set to a true value to make it return
631 undef instead.
632
633 #### `add_underlay($)`
634
635 Adds a directory to the set of underlay directories that ikiwiki will
636 search for files.
637
638 If the directory name is not absolute, ikiwiki will assume it is in
639 the parent directory of the configured underlaydir.
640
641 #### `displaytime($;$)`
642
643 Given a time, formats it for display.
644
645 The optional second parameter is a strftime format to use to format the
646 time.
647
648 #### `gettext`
649
650 This is the standard gettext function, although slightly optimised.
651
652 #### `urlto($$;$)`
653
654 Construct a relative url to the first parameter from the page named by the
655 second. The first parameter can be either a page name, or some other
656 destination file, as registered by `will_render`.
657
658 If the third parameter is passed and is true, an absolute url will be
659 constructed instead of the default relative url.
660
661 #### `targetpage($$)`
662
663 Passed a page and an extension, returns the filename that page will be
664 rendered to.
665
666 ## Miscellaneous
667
668 ### Internal use pages
669
670 Sometimes it's useful to put pages in the wiki without the overhead of
671 having them be rendered to individual html files. Such internal use pages
672 are collected together to form the RecentChanges page, for example.
673
674 To make an internal use page, register a filename extension that starts
675 with "_". Internal use pages cannot be edited with the web interface,
676 generally shouldn't contain wikilinks or preprocessor directives (use
677 either on them with extreme caution), and are not matched by regular
678 PageSpecs glob patterns, but instead only by a special `internal()`
679 [[ikiwiki/PageSpec]].
680
681 ### RCS plugins
682
683 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
684 plugins. See [[RCS_details|rcs/details]] for some more info.
685
686 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
687 and the 'id' field is set to the name of the hook. For example:
688         
689         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
690         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
691
692 #### `rcs_update()`
693
694 Updates the working directory with any remote changes.
695
696 #### `rcs_prepedit($)`
697
698 Is passed a file to prepare to edit. It can generate and return an arbitrary
699 token, that will be passed into `rcs_commit` when committing. For example,
700 it might return the current revision ID of the file, and use that
701 information later when merging changes.
702
703 #### `rcs_commit($$$;$$)`
704
705 Passed a file, message, token (from `rcs_prepedit`), user, and ip address.
706 Should try to commit the file. Returns `undef` on *success* and a version
707 of the page with the rcs's conflict markers on failure.
708
709 #### `rcs_commit_staged($$$)`
710
711 Passed a message, user, and ip address. Should commit all staged changes.
712 Returns undef on success, and an error message on failure.
713
714 Changes can be staged by calls to `rcs_add, `rcs_remove`, and
715 `rcs_rename`.
716
717 #### `rcs_add($)`
718
719 Adds the passed file to the archive. The filename is relative to the root
720 of the srcdir.
721
722 Note that this should not check the new file in, it should only
723 prepare for it to be checked in when rcs_commit (or `rcs_commit_staged`) is
724 called. Note that the file may be in a new subdir that is not yet in
725 to version control; the subdir can be added if so.
726
727 #### `rcs_remove($)`
728
729 Remove a file. The filename is relative to the root of the srcdir.
730
731 Note that this should not check the removal in, it should only prepare for it
732 to be checked in when `rcs_commit` (or `rcs_commit_staged`) is called. Note
733 that the new file may be in a new subdir that is not yet inversion
734 control; the subdir can be added if so.
735
736 #### `rcs_rename($$)`
737
738 Rename a file. The filenames are relative to the root of the srcdir.
739
740 Note that this should not commit the rename, it should only
741 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
742 The new filename may be in a new subdir, that is not yet added to
743 version control. If so, the subdir will exist already, and should
744 be added to revision control.
745
746 #### `rcs_recentchanges($)`
747
748 Examine the RCS history and generate a list of recent changes.
749 The parameter is how many changes to return.
750
751 The data structure returned for each change is:
752
753         {
754                 rev => # the RCSs id for this commit
755                 user => # name of user who made the change,
756                 committype => # either "web" or the name of the rcs,
757                 when => # time when the change was made,
758                 message => [
759                         { line => "commit message line 1" },
760                         { line => "commit message line 2" },
761                         # etc,
762                 ],
763                 pages => [
764                         {
765                                 page => # name of page changed,
766                                 diffurl => # optional url to a diff of changes
767                         },
768                         # repeat for each page changed in this commit,
769                 ],
770         }
771
772 #### `rcs_diff($)`
773
774 The parameter is the rev from `rcs_recentchanges`.
775 Should return a list of lines of the diff (including \n) in list
776 context, and the whole diff in scalar context.
777
778 #### `rcs_getctime($)`
779
780 This is used to get the page creation time for a file from the RCS, by looking
781 it up in the history.
782
783 It's ok if this is not implemented, and throws an error.
784
785 ### PageSpec plugins
786
787 It's also possible to write plugins that add new functions to
788 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
789 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
790 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
791 two parameters: The name of the page being matched, and the thing to match
792 against. It may also be passed additional, named parameters. It should return
793 a IkiWiki::SuccessReason object if the match succeeds, or an
794 IkiWiki::FailReason object if the match fails.
795
796 ### Setup plugins
797
798 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
799 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
800 and the rest of the file is passed to that module's import method.
801
802 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
803 can be used to configure ikiwiki in different ways. These modules should,
804 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
805 to a hash containing all the config items. They should also implement a
806 `gendump` function.
807
808 By the way, to parse a ikiwiki setup file and populate `%config`, a
809 program just needs to do something like:
810 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`