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