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