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