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