]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/write.mdwn
Add a fullpage arg to filter.
[git.ikiwiki.info.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]].
6 [[!template id="note" text="""
7 Ikiwiki is a compiler
9 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
10 *compiler*. So plugins influence pages when they are built, not when they
11 are loaded. A plugin that inserts the current time into a page, for
12 example, will insert the build time.
14 Also, as a compiler, ikiwiki avoids rebuilding pages unless they have
15 changed, so a plugin that prints some random or changing thing on a page
16 will generate a static page that won't change until ikiwiki rebuilds the
17 page for some other reason, like the page being edited.
19 The [[tutorial]] has some other examples of ways that ikiwiki being a
20 compiler may trip up the unwary.
21 """]]
23 [[!toc levels=2]]
25 ## Highlevel view of ikiwiki
27 Ikiwiki mostly has two modes of operation. It can either be running
28 as a compiler, building or updating a wiki; or as a cgi program, providing
29 user interface for editing pages, etc. Almost everything ikiwiki does
30 is accomplished by calling various hooks provided by plugins.
32 ### compiler
34 As a compiler, ikiwiki starts by calling the `refresh` hook. Then it checks
35 the wiki's source to find new or changed pages. The `needsbuild` hook is
36 then called to allow manipulation of the list of pages that need to be
37 built. 
39 Now that it knows what pages it needs to build, ikiwiki runs two
40 compile passes. First, it runs `scan` hooks, which collect metadata about
41 the pages. Then it runs a page rendering pipeline, by calling in turn these
42 hooks: `filter`, `preprocess`, `linkify`, `htmlize`, `indexhtml`,
43 `pagetemplate`, `sanitize`, `format`.
45 After all necessary pages are built, it calls the `change` hook. Finally,
46 if a page is was deleted, the `delete` hook is called, and the files that
47 page had previously produced are removed.
49 ### cgi
51 The flow between hooks when ikiwiki is run as a cgi is best illustrated by
52 an example.
54 Alice browses to a page and clicks Edit.
56 * Ikiwiki is run as a cgi. It assigns Alice a session cookie, and,
57   by calling the `auth` hooks, sees that she is not yet logged in.
58 * The `sessioncgi` hooks are then called, and one of them,
59   from the [[editpage]] plugin, notices that the cgi has been told "do=edit".
60 * The [[editpage]] plugin calls the `canedit` hook to check if this
61   page edit is allowed. The [[signinedit]] plugin has a hook that says not:
62   Alice is not signed in.
63 * The [[signinedit]] plugin then launches the signin process. A signin
64   page is built by calling the `formbuilder_setup` hook.
66 Alice signs in with her openid.
68 * The [[openid]] plugin's `formbuilder` hook sees that an openid was
69   entered in the signin form, and redirects to Alice's openid provider.
70 * Alice's openid provider calls back to ikiwiki. The [[openid]] plugin
71   has an `auth` hook that finishes the openid signin process.
72 * Signin complete, ikiwiki returns to what Alice was doing before; editing
73   a page.
74 * Now all the `canedit` hooks are happy. The [[editpage]] plugin calls
75   `formbuilder_setup` to display the page editing form.
77 Alice saves her change to the page.
79 * The [[editpage]] plugin's `formbuilder` hook sees that the Save button
80   was pressed, and calls the `checkcontent` and `editcontent` hooks.
81   Then it saves the page to disk, and branches into the compiler part
82   of ikiwiki to refresh the wiki.
84 ## Types of plugins
86 Most ikiwiki [[plugins]] are written in perl, like ikiwiki. This gives the
87 plugin full access to ikiwiki's internals, and is the most efficient.
88 However, plugins can actually be written in any language that supports XML
89 RPC. These are called [[external]] plugins.
91 A plugin written in perl is a perl module, in the `IkiWiki::Plugin`
92 namespace. The name of the plugin is typically in lowercase, such as
93 `IkiWiki::Plugin::inline`. Ikiwiki includes a `IkiWiki::Plugin::skeleton`
94 that can be fleshed out to make a useful plugin.
95 `IkiWiki::Plugin::pagecount` is another simple example. All perl plugins
96 should `use IkiWiki` to import the ikiwiki plugin interface. It's a good
97 idea to include the version number of the plugin interface that your plugin
98 expects: `use IkiWiki 3.00`.
100 An external plugin is an executable program. It can be written in any
101 language. Its interface to ikiwiki is via XML RPC, which it reads from
102 ikiwiki on its standard input, and writes to ikiwiki on its standard
103 output. For more details on writing external plugins, see [[external]].
105 Despite these two types of plugins having such different interfaces,
106 they're the same as far as how they hook into ikiwiki. This document will
107 explain how to write both sorts of plugins, albeit with an emphasis on perl
108 plugins.
110 ## Plugin interface
112 To import the ikiwiki plugin interface:
114         use IkiWiki '3.00';
116 This will import several variables and functions into your plugin's
117 namespace. These variables and functions are the ones most plugins need,
118 and a special effort will be made to avoid changing them in incompatible
119 ways, and to document any changes that have to be made in the future.
121 Note that IkiWiki also provides other variables and functions that are not
122 exported by default. No guarantee is made about these in the future, so if
123 it's not exported, the wise choice is to not use it.
125 ## Registering plugins
127 Plugins should, when imported, call `hook()` to hook into ikiwiki's
128 processing. The function uses named parameters, and use varies depending on
129 the type of hook being registered -- see below. A plugin can call
130 the function more than once to register multiple hooks.
132 All calls to `hook()` should be passed a "type" parameter, which gives the
133 type of hook, a "id" parameter, which should be a unique string for this
134 plugin, and a "call" parameter, which tells what function to call for the
135 hook.
137 An optional "last" parameter, if set to a true value, makes the hook run
138 after all other hooks of its type, and an optional "first" parameter makes
139 it run first. Useful if the hook depends on some other hook being run first.
141 ## Types of hooks
143 In roughly the order they are called.
145 ### getopt
147         hook(type => "getopt", id => "foo", call => \&getopt);
149 This allows for plugins to perform their own processing of command-line
150 options and so add options to the ikiwiki command line. It's called during
151 command line processing, with `@ARGV` full of any options that ikiwiki was
152 not able to process on its own. The function should process any options it
153 can, removing them from `@ARGV`, and probably recording the configuration
154 settings in `%config`. It should take care not to abort if it sees
155 an option it cannot process, and should just skip over those options and
156 leave them in `@ARGV`.
158 ### checkconfig
160         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
162 This is useful if the plugin needs to check for or modify ikiwiki's
163 configuration. It's called early in the startup process. `%config`
164 is populated at this point, but other state has not yet been loaded.
165 The function is passed no values. It's ok for the function to call
166 `error()` if something isn't configured right.
168 ### refresh
170         hook(type => "refresh", id => "foo", call => \&refresh);
172 This hook is called just before ikiwiki scans the wiki for changed files.
173 It's useful for plugins that need to create or modify a source page. The
174 function is passed no values.
176 ### needsbuild
178         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
180 This allows a plugin to manipulate the list of files that need to be
181 built when the wiki is refreshed. The function is passed a reference to an
182 array of files that will be rebuilt, and can modify the array, either
183 adding or removing files from it.
185 ### scan
187         hook(type => "scan", id => "foo", call => \&scan);
189 This hook is called early in the process of building the wiki, and is used
190 as a first pass scan of the page, to collect metadata about the page. It's
191 mostly used to scan the page for [[WikiLinks|ikiwiki/WikiLink]], and add
192 them to `%links`. Present in IkiWiki 2.40 and later.
194 The function is passed named parameters "page" and "content". Its return
195 value is ignored.
197 ### filter
199         hook(type => "filter", id => "foo", call => \&filter);
201 Runs on the raw source of a page, before anything else touches it, and can
202 make arbitrary changes. The function is passed named parameters "page",
203 "destpage", "content" and "fullpage". "fullpage" is a true value if,
204 and only if, a full page's content is being filtered, e.g. as opposed
205 to a directive parameter. It should return the filtered content.
207 ### preprocess
209 Adding a preprocessor [[ikiwiki/directive]] is probably the most common use
210 of a plugin.
212         hook(type => "preprocess", id => "foo", call => \&preprocess);
214 Replace "foo" with the command name that will be used for the preprocessor
215 directive.
217 Each time the directive is processed, the referenced function (`preprocess`
218 in the example above) is called. Whatever the function returns goes onto
219 the page in place of the directive. Or, if the function aborts using
220 `error()`, the directive will be replaced with the error message.
222 The function is passed named parameters. First come the parameters set
223 in the preprocessor directive. These are passed in the same order as
224 they're in the directive, and if the preprocessor directive contains a bare
225 parameter (example: `\[[!foo param]]`), that parameter will be passed with
226 an empty value.
228 After the parameters from the preprocessor directive some additional ones
229 are passed: A "page" parameter gives the name of the page that embedded the
230 preprocessor directive, while a "destpage" parameter gives the name of the
231 page the content is going to (different for inlined pages), and a "preview"
232 parameter is set to a true value if the page is being previewed.
234 If `hook` is passed an optional "scan" parameter, set to a true value, this
235 makes the hook be called during the preliminary scan that ikiwiki makes of
236 updated pages, before begining to render pages. This should be done if the
237 hook modifies data in `%links` (typically by calling `add_link`). Note that
238 doing so will make the hook be run twice per page build, so avoid doing it
239 for expensive hooks. (As an optimisation, if your preprocessor hook is
240 called in a void context, you can assume it's being run in scan mode, and
241 avoid doing expensive things at that point.)
243 Note that if the [[htmlscrubber]] is enabled, html in
244 preprocessor [[ikiwiki/directive]] output is sanitised, which may limit what
245 your plugin can do. Also, the rest of the page content is not in html
246 format at preprocessor time. Text output by a preprocessor directive will
247 be linkified and passed through markdown (or whatever engine is used to
248 htmlize the page) along with the rest of the page.
250 ### linkify
252         hook(type => "linkify", id => "foo", call => \&linkify);
254 This hook is called to convert [[WikiLinks|ikiwiki/WikiLink]] on the page into html
255 links. The function is passed named parameters "page", "destpage", and
256 "content". It should return the linkified content.  Present in IkiWiki 2.40
257 and later.
259 Plugins that implement linkify must also implement a scan hook, that scans
260 for the links on the page and adds them to `%links` (typically by calling
261 `add_link`).
263 ### htmlize
265         hook(type => "htmlize", id => "ext", call => \&htmlize);
267 Runs on the source of a page and turns it into html. The id parameter
268 specifies the filename extension that a file must have to be htmlized using
269 this plugin. This is how you can add support for new and exciting markup
270 languages to ikiwiki.
272 The function is passed named parameters: "page" and "content" and should
273 return the htmlized content.
275 If `hook` is passed an optional "keepextension" parameter, set to a true
276 value, then the extension will not be stripped from the source filename when
277 generating the page.
279 If `hook` is passed an optional "noextension" parameter, set to a true
280 value, then the id parameter specifies not a filename extension, but
281 a whole filename that can be htmlized. This is useful for files
282 like `Makefile` that have no extension.
284 If `hook` is passed an optional "longname" parameter, this value is used
285 when prompting a user to choose a page type on the edit page form.
287 ### indexhtml
289         hook(type => "indexhtml", id => "foo", call => \&indexhtml);
291 This hook is called once the page has been converted to html (but before
292 the generated html is put in a template). The most common use is to
293 update search indexes. Added in ikiwiki 2.54.
295 The function is passed named parameters "page", "destpage", and "content".
296 Its return value is ignored.
298 ### pagetemplate
300         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
302 [[Templates]] are filled out for many different things in
303 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
304 a cgi. This hook allows modifying the variables available on those
305 templates. The function is passed named parameters. The "page" and
306 "destpage" parameters are the same as for a preprocess hook. The "template"
307 parameter is a [[!cpan HTML::Template]] object that is the template that
308 will be used to generate the page. The function can manipulate that
309 template object.
311 The most common thing to do is probably to call `$template->param()` to add
312 a new custom parameter to the template.
314 ### templatefile
316         hook(type => "templatefile", id => "foo", call => \&templatefile);
318 This hook allows plugins to change the [[template|templates]] that is
319 used for a page in the wiki. The hook is passed a "page" parameter, and
320 should return the name of the template file to use (relative to the
321 template directory), or undef if it doesn't want to change the default
322 ("page.tmpl").
324 ### pageactions
326         hook(type => "pageactions", id => "foo", call => \&pageactions);
328 This hook allows plugins to add arbitrary actions to the action bar on a
329 page (next to Edit, RecentChanges, etc). The hook is passed a "page"
330 parameter, and can return a list of html fragments to add to the action
331 bar.
333 ### sanitize
335         hook(type => "sanitize", id => "foo", call => \&sanitize);
337 Use this to implement html sanitization or anything else that needs to
338 modify the body of a page after it has been fully converted to html.
340 The function is passed named parameters: "page", "destpage", and "content",
341 and should return the sanitized content.
343 ### format
345         hook(type => "format", id => "foo", call => \&format);
347 The difference between format and sanitize is that sanitize only acts on
348 the page body, while format can modify the entire html page including the
349 header and footer inserted by ikiwiki, the html document type, etc. (It
350 should not rely on always being passed the entire page, as it won't be
351 when the page is being previewed.)
353 The function is passed named parameters: "page" and "content", and 
354 should return the formatted content.
356 ### delete
358         hook(type => "delete", id => "foo", call => \&delete);
360 Each time a page or pages is removed from the wiki, the referenced function
361 is called, and passed the names of the source files that were removed.
363 ### change
365         hook(type => "change", id => "foo", call => \&render);
367 Each time ikiwiki renders a change or addition (but not deletion) to the
368 wiki, the referenced function is called, and passed the names of the
369 source files that were rendered.
371 ### cgi
373         hook(type => "cgi", id => "foo", call => \&cgi);
375 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
376 called in turn, and passed a CGI object. The hook should examine the
377 parameters, and if it will handle this CGI request, output a page
378 (including the http headers) and terminate the program.
380 Note that cgi hooks are called as early as possible, before any ikiwiki
381 state is loaded, and with no session information.
383 ### auth
385         hook(type => "auth", id => "foo", call => \&auth);
387 This hook can be used to implement an authentication method. When a user
388 needs to be authenticated, each registered auth hook is called in turn, and
389 passed a CGI object and a session object. 
391 If the hook is able to authenticate the user, it should set the session
392 object's "name" parameter to the authenticated user's name. Note that
393 if the name is set to the name of a user who is not registered,
394 a basic registration of the user will be automatically performed.
396 ### sessioncgi
398         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
400 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
401 is only run once a session object is available. It is passed both a CGI
402 object and a session object. To check if the user is in fact signed in, you
403 can check if the session object has a "name" parameter set.
405 ### canedit
407         hook(type => "canedit", id => "foo", call => \&canedit);
409 This hook can be used to implement arbitrary access methods to control when
410 a page can be edited using the web interface (commits from revision control
411 bypass it). When a page is edited, each registered canedit hook is called
412 in turn, and passed the page name, a CGI object, and a session object.
414 If the hook has no opinion about whether the edit can proceed, return
415 `undef`, and the next plugin will be asked to decide. If edit can proceed,
416 the hook should return "". If the edit is not allowed by this hook, the
417 hook should return an error message for the user to see, or a function 
418 that can be run to log the user in or perform other action necessary for
419 them to be able to edit the page.
421 This hook should avoid directly redirecting the user to a signin page,
422 since it's sometimes used to test to see which pages in a set of pages a
423 user can edit.
425 ### canremove
427         hook(type => "canremove", id => "foo", call => \&canremove);
429 This hook can be used to implement arbitrary access methods to control
430 when a page can be removed using the web interface (commits from
431 revision control bypass it). It works exactly like the `canedit` hook,
432 but is passed the named parameters `cgi` (a CGI object), `session`
433 (a session object) and `page` (the page subject to deletion).
435 ### canrename
437         hook(type => "canrename", id => "foo", call => \&canrename);
439 This hook can be used to implement arbitrary access methods to control when
440 a page can be renamed using the web interface (commits from revision control
441 bypass it). It works exactly like the `canedit` hook,
442 but is passed the named parameters `cgi` (a CGI object), `session` (a
443 session object), `src`, `srcfile`, `dest` and `destfile`.
445 ### checkcontent
446         
447         hook(type => "checkcontent", id => "foo", call => \&checkcontent);
449 This hook is called to check the content a user has entered on a page,
450 before it is saved, and decide if it should be allowed.
452 It is passed named parameters: `content`, `page`, `cgi`, and `session`. If
453 the content the user has entered is a comment, it may also be passed some
454 additional parameters: `author`, `url`, and `subject`. The `subject`
455 parameter may also be filled with the user's comment about the change.
457 Note: When the user edits an existing wiki page, this hook is also
458 passed a `diff` named parameter, which will include only the lines
459 that they added to the page, or modified.
461 The hook should return `undef` on success. If the content is disallowed, it
462 should return a message stating what the problem is, or a function
463 that can be run to perform whatever action is necessary to allow the user
464 to post the content.
466 ### editcontent
468         hook(type => "editcontent", id => "foo", call => \&editcontent);
470 This hook is called when a page is saved (or previewed) using the web
471 interface. It is passed named parameters: `content`, `page`, `cgi`, and
472 `session`. These are, respectively, the new page content as entered by the
473 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
475 It can modify the content as desired, and should return the content.
477 ### formbuilder
479         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
480         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
482 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
483 CGI::FormBuilder]] to generate web forms. These hooks are passed named
484 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
485 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
486 reference to an array of names of buttons to go on the form.
488 Each time a form is set up, the `formbuilder_setup` hook is called.
489 Typically the `formbuilder_setup` hook will check the form's title, and if
490 it's a form that it needs to modify, will call various methods to
491 add/remove/change fields, tweak the validation code for the fields, etc. It
492 will not validate or display the form.
494 Just before a form is displayed to the user, the `formbuilder` hook is
495 called. It can be used to validate the form, but should not display it.
497 ### savestate
499         hook(type => "savestate", id => "foo", call => \&savestate);
501 This hook is called whenever ikiwiki normally saves its state, just before
502 the state is saved. The function can save other state, modify values before
503 they're saved, etc.
505 ### renamepage
507         hook(type => "renamepage", id => "foo", call => \&renamepage);
509 This hook is called by the [[plugins/rename]] plugin when it renames
510 something, once per page linking to the renamed page's old location.
511 The hook is passed named parameters: `page`, `oldpage`, `newpage`, and
512 `content`, and should try to modify the content of `page` to reflect
513 the name change. For example, by converting links to point to the
514 new page.
516 ### rename
518         hook(type => "rename", id => "foo", call => \&rename);
520 When a page or set of pages is renamed, the referenced function is
521 called for every page, and is passed named parameters:
523 * `torename`: a reference to a hash with keys: `src`, `srcfile`,
524   `dest`, `destfile`, `required`.
525 * `cgi`: a CGI object
526 * `session`: a session object.
528 Such a hook function returns any additional rename hashes it wants to
529 add. This hook is applied recursively to returned additional rename
530 hashes, so that it handles the case where two plugins use the hook:
531 plugin A would see when plugin B adds a new file to be renamed.
533 ### getsetup
535         hook(type => "getsetup", id => "foo", call => \&getsetup);
537 This hooks is not called during normal operation, but only when setting up 
538 the wiki, or generating a setup file. Plugins can use this hook to add
539 configuration options.
541 The hook is passed no parameters. It returns data about the configuration
542 options added by the plugin. It can also check if the plugin is usable, and
543 die if not, which will cause the plugin to not be offered in the configuration
544 interface.
546 The data returned is a list of `%config` options, followed by a hash
547 describing the option. There can also be an item named "plugin", which
548 describes the plugin as a whole. For example:
550                 return
551                         plugin => {
552                                 description => "description of this plugin",
553                                 safe => 1,
554                                 rebuild => 1,
555                                 section => "misc",
556                         },
557                         option_foo => {
558                                 type => "boolean",
559                                 description => "enable foo?",
560                                 advanced => 1,
561                                 safe => 1,
562                                 rebuild => 1,
563                         },
564                         option_bar => {
565                                 type => "string",
566                                 example => "hello",
567                                 description => "option bar",
568                                 safe => 1,
569                                 rebuild => 0,
570                         },
572 * `type` can be "boolean", "string", "integer", "pagespec",
573   or "internal" (used for values that are not user-visible). The type is
574   the type of the leaf values;  the `%config` option may be an array or
575   hash of these.
576 * `example` can be set to an example value.
577 * `description` is a short description of the option.
578 * `link` is a link to further information about the option. This can either
579   be a [[ikiwiki/WikiLink]], or an url.
580 * `advanced` can be set to true if the option is more suitable for advanced
581   users.
582 * `safe` should be false if the option should not be displayed in unsafe
583   configuration methods, such as the web interface. Anything that specifies
584   a command to run, a path on disk, or a regexp should be marked as unsafe.
585   If a plugin is marked as unsafe, that prevents it from being
586   enabled/disabled.
587 * `rebuild` should be true if changing the option (or enabling/disabling
588   the plugin) will require a wiki rebuild, false if no rebuild is needed,
589   and undef if a rebuild could be needed in some circumstances, but is not
590   strictly required.
591 * `section` can optionally specify which section in the config file
592   the plugin fits in. The convention is to name the sections the
593   same as the tags used for [[plugins|plugin]] on this wiki.
595 ### genwrapper
597         hook(type => "genwrapper", id => "foo", call => \&genwrapper);
599 This hook is used to inject C code (which it returns) into the `main`
600 function of the ikiwiki wrapper when it is being generated.
602 ## Exported variables
604 Several variables are exported to your plugin when you `use IkiWiki;`
606 ### `%config`
608 A plugin can access the wiki's configuration via the `%config`
609 hash. The best way to understand the contents of the hash is to look at
610 your ikiwiki setup file, which sets the hash content to configure the wiki.
612 ### `%pagestate`
614 The `%pagestate` hash can be used by plugins to save state that they will need
615 next time ikiwiki is run. The hash holds per-page state, so to set a value,
616 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
617 use `$pagestate{$page}{$id}{$key}`.
619 The `$value` can be anything that perl's Storable module is capable of
620 serializing. `$key` can be any string you like, but `$id` must be the same
621 as the "id" parameter passed to `hook()` when registering the plugin. This
622 is so ikiwiki can know when to delete pagestate for plugins that are no
623 longer used.
625 When pages are deleted, ikiwiki automatically deletes their pagestate too.
627 Note that page state does not persist across wiki rebuilds, only across
628 wiki updates.
630 ### `%wikistate`
632 The `%wikistate` hash can be used by a plugin to store persistant state
633 that is not bound to any one page. To set a value, use
634 `$wikistate{$id}{$key}=$value, where `$value` is anything Storable can
635 serialize, `$key` is any string you like, and `$id` must be the same as the
636 "id" parameter passed to `hook()` when registering the plugin, so that the
637 state can be dropped if the plugin is no longer used.
639 ### `%links`
641 The `%links` hash can be used to look up the names of each page that
642 a page links to. The name of the page is the key; the value is an array
643 reference. Do not modify this hash directly; call `add_link()`.
645         $links{"foo"} = ["bar", "baz"];
647 ### `%typedlinks`
649 The `%typedlinks` hash records links of specific types. Do not modify this
650 hash directly; call `add_link()`. The keys are page names, and the values
651 are hash references. In each page's hash reference, the keys are link types
652 defined by plugins, and the values are hash references with link targets
653 as keys, and 1 as a dummy value, something like this:
655         $typedlinks{"foo"} = {
656                 tag => { short_word => 1, metasyntactic_variable => 1 },
657                 next_page => { bar => 1 },
658         };
660 Ordinary [[WikiLinks|ikiwiki/WikiLink]] appear in `%links`, but not in
661 `%typedlinks`.
663 ### `%pagesources`
665 The `%pagesources` has can be used to look up the source filename
666 of a page. So the key is the page name, and the value is the source
667 filename. Do not modify this hash.
669         $pagesources{"foo"} = "foo.mdwn";
671 ### `%destsources`
673 The `%destsources` hash records the name of the source file used to
674 create each destination file. The key is the output filename (ie,
675 "foo/index.html"), and the value is the source filename that it was built
676 from (eg, "foo.mdwn"). Note that a single source file may create multiple
677 destination files. Do not modify this hash directly; call `will_render()`.
678         
679         $destsources{"foo/index.html"} = "foo.mdwn";
681 ## Library functions
683 Several functions are exported to your plugin when you `use IkiWiki;`
685 ### `hook(@)`
687 Hook into ikiwiki's processing. See the discussion of hooks above.
689 Note that in addition to the named parameters described above, a parameter
690 named `no_override` is supported, If it's set to a true value, then this hook
691 will not override any existing hook with the same id. This is useful if
692 the id can be controled by the user.
694 ### `debug($)`
696 Logs a debugging message. These are supressed unless verbose mode is turned
697 on.
699 ### `error($;$)`
701 Aborts with an error message. If the second parameter is passed, it is a
702 function that is called after the error message is printed, to do any final
703 cleanup.
705 If called inside a preprocess hook, error() does not abort the entire
706 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
707 a version containing the error message.
709 In other hooks, error() is a fatal error, so use with care. Try to avoid
710 dying on bad input when building a page, as that will halt
711 the entire wiki build and make the wiki unusable.
713 ### `template($;@)`
715 Creates and returns a [[!cpan HTML::Template]] object. (In a list context,
716 returns the parameters needed to construct the obhect.) 
718 The first parameter is the name of the template file. The optional remaining
719 parameters are passed to `HTML::Template->new`.
721 Normally, the template file is first looked for in the templates/ subdirectory
722 of the srcdir. Failing that, it is looked for in the templatedir.
724 Wiki pages can be used as templates. This should be done only for templates
725 which it is safe to let wiki users edit. Enable it by passing a filename
726 with no ".tmpl" extension. Template pages are normally looked for in
727 the templates/ directory. If the page name starts with "/", a page
728 elsewhere in the wiki can be used.
730 ### `template_depends($$;@)`
732 Use this instead of `template()` if the content of a template is being
733 included into a page. This causes the page to depend on the template,
734 so it will be updated if the template is modified.
736 Like `template()`, except the second parameter is the page.
738 ### `htmlpage($)`
740 Passed a page name, returns the base name that will be used for a the html
741 page created from it. (Ie, it appends ".html".)
743 Use this when constructing the filename of a html file. Use `urlto` when
744 generating a link to a page.
746 ### `pagespec_match_list($$;@)`
748 Passed a page name, and [[ikiwiki/PageSpec]], returns a list of pages
749 in the wiki that match the [[ikiwiki/PageSpec]]. 
751 The page will automatically be made to depend on the specified
752 [[ikiwiki/PageSpec]], so `add_depends` does not need to be called. This
753 is often significantly more efficient than calling `add_depends` and
754 `pagespec_match` in a loop. You should use this anytime a plugin
755 needs to match a set of pages and do something based on that list.
757 Unlike pagespec_match, this may throw an error if there is an error in
758 the pagespec.
760 Additional named parameters can be specified:
762 * `deptype` optionally specifies the type of dependency to add. Use the
763   `deptype` function to generate a dependency type.
764 * `filter` is a reference to a function, that is called and passed a page,
765   and returns true if the page should be filtered out of the list.
766 * `sort` specifies a sort order for the list. See
767   [[ikiwiki/PageSpec/sorting]] for the avilable sort methods. Note that
768   if a sort method is specified that depends on the
769   page content (such as 'meta(foo)'), the deptype needs to be set to
770   a content dependency.
771 * `reverse` if true, sorts in reverse.
772 * `num` if nonzero, specifies the maximum number of matching pages that
773   will be returned.
774 * `list` makes it only match amoung the specified list of pages.
775   Default is to match amoung all pages in the wiki.
777 Any other named parameters are passed on to `pagespec_match`, to further
778 limit the match.
780 ### `add_depends($$;$)`
782 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
784 By default, dependencies are full content dependencies, meaning that the
785 page will be updated whenever anything matching the PageSpec is modified.
786 This can be overridden by passing a `deptype` value as the third parameter.
788 ### `pagespec_match($$;@)`
790 Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
791 [[ikiwiki/PageSpec]] matches the page.
793 Note that the return value is overloaded. If stringified, it will be a
794 message indicating why the PageSpec succeeded, or failed, to match the
795 page.
797 Additional named parameters can be passed, to further limit the match.
798 The most often used is "location", which specifies the location the
799 PageSpec should match against. If not passed, relative PageSpecs will match
800 relative to the top of the wiki.
802 ### `deptype(@)`
804 Use this function to generate ikiwiki's internal representation of a
805 dependency type from one or more of these keywords:
807 * `content` is the default. Any change to the content
808   of a page triggers the dependency.
809 * `presence` is only triggered by a change to the presence
810   of a page.
811 * `links` is only triggered by a change to the links of a page.
812   This includes when a link is added, removed, or changes what
813   it points to due to other changes. It does not include the
814   addition or removal of a duplicate link.
816 If multiple types are specified, they are combined.
818 ### `bestlink($$)`
820 Given a page and the text of a link on the page, determine which
821 existing page that link best points to. Prefers pages under a
822 subdirectory with the same name as the source page, failing that
823 goes down the directory tree to the base looking for matching
824 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
826 ### `htmllink($$$;@)`
828 Many plugins need to generate html links and add them to a page. This is
829 done by using the `htmllink` function. The usual way to call
830 `htmllink` is:
832         htmllink($page, $page, $link)
834 Why is `$page` repeated? Because if a page is inlined inside another, and a
835 link is placed on it, the right way to make that link is actually:
837         htmllink($page, $destpage, $link)
839 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
840 some of the hook functions above; the ones that are not passed it are not used
841 during inlining and don't need to worry about this issue.
843 After the three required parameters, named parameters can be used to
844 control some options. These are:
846 * noimageinline - set to true to avoid turning links into inline html images
847 * forcesubpage  - set to force a link to a subpage
848 * linktext - set to force the link text to something
849 * anchor - set to make the link include an anchor
850 * rel - set to add a rel attribute to the link
851 * class - set to add a css class to the link
852 * title - set to add a title attribute to the link
854 ### `readfile($;$)`
856 Given a filename, reads and returns the entire file.
858 The optional second parameter, if set to a true value, makes the file be read
859 in binary mode.
861 A failure to read the file will result in it dying with an error.
863 ### `writefile($$$;$$)`
865 Given a filename, a directory to put it in, and the file's content,
866 writes a file. 
868 The optional fourth parameter, if set to a true value, makes the file be
869 written in binary mode.
871 The optional fifth parameter can be used to pass a function reference that
872 will be called to handle writing to the file. The function will be called
873 and passed a file descriptor it should write to, and an error recovery
874 function it should call if the writing fails. (You will not normally need to
875 use this interface.)
877 A failure to write the file will result in it dying with an error.
879 If the destination directory doesn't exist, it will first be created.
881 The filename and directory are separate parameters because of
882 some security checks done to avoid symlink attacks. Before writing a file,
883 it checks to make sure there's not a symlink with its name, to avoid
884 following the symlink. If the filename parameter includes a subdirectory
885 to put the file in, it also checks if that subdirectory is a symlink, etc.
886 The directory parameter, however, is not checked for symlinks. So,
887 generally the directory parameter is a trusted toplevel directory like
888 the srcdir or destdir, and any subdirectories of this are included in the
889 filename parameter.
891 ### `will_render($$)`
893 Given a page name and a destination file name (not including the base
894 destination directory), register that the page will result in that file
895 being rendered. 
897 It's important to call this before writing to any file in the destination
898 directory, and it's important to call it consistently every time, even if
899 the file isn't really written this time -- unless you delete any old
900 version of the file. In particular, in preview mode, this should still be
901 called even if the file isn't going to be written to during the preview.
903 Ikiwiki uses this information to automatically clean up rendered files when
904 the page that rendered them goes away or is changed to no longer render
905 them. will_render also does a few important security checks.
907 ### `pagetype($)`
909 Given the name of a source file, returns the type of page it is, if it's
910 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
912 ### `pagename($)`
914 Given the name of a source file, returns the name of the wiki page
915 that corresponds to that file.
917 ### `pagetitle($)`
919 Give the name of a wiki page, returns a version suitable to be displayed as
920 the page's title. This is accomplished by de-escaping escaped characters in
921 the page name. "_" is replaced with a space, and '__NN__' is replaced by 
922 the UTF character with code NN.
924 ### `titlepage($)`
926 This performs the inverse of `pagetitle`, ie, it converts a page title into
927 a wiki page name.
929 ### `linkpage($)`
931 This converts text that could have been entered by the user as a
932 [[ikiwiki/WikiLink]] into a wiki page name.
934 ### `srcfile($;$)`
936 Given the name of a source file in the wiki, searches for the file in
937 the source directory and the underlay directories (most recently added
938 underlays first), and returns the full path to the first file found.
940 Normally srcfile will fail with an error message if the source file cannot
941 be found. The second parameter can be set to a true value to make it return
942 undef instead.
944 ### `add_underlay($)`
946 Adds a directory to the set of underlay directories that ikiwiki will
947 search for files.
949 If the directory name is not absolute, ikiwiki will assume it is in
950 the parent directory of the configured underlaydir.
952 ### `displaytime($;$$)`
954 Given a time, formats it for display.
956 The optional second parameter is a strftime format to use to format the
957 time.
959 If the third parameter is true, this is the publication time of a page.
960 (Ie, set the html5 pubdate attribute.)
962 ### `gettext`
964 This is the standard gettext function, although slightly optimised.
966 ### `ngettext`
968 This is the standard ngettext function, although slightly optimised.
970 ### `urlto($$;$)`
972 Construct a relative url to the first parameter from the page named by the
973 second. The first parameter can be either a page name, or some other
974 destination file, as registered by `will_render`.
976 If the third parameter is passed and is true, an absolute url will be
977 constructed instead of the default relative url.
979 ### `newpagefile($$)`
981 This can be called when creating a new page, to determine what filename
982 to save the page to. It's passed a page name, and its type, and returns
983 the name of the file to create, relative to the srcdir.
985 ### `targetpage($$;$)`
987 Passed a page and an extension, returns the filename that page will be
988 rendered to.
990 Optionally, a third parameter can be passed, to specify the preferred
991 filename of the page. For example, `targetpage("foo", "rss", "feed")`
992 will yield something like `foo/feed.rss`.
994 ### `add_link($$;$)`
996 This adds a link to `%links`, ensuring that duplicate links are not
997 added. Pass it the page that contains the link, and the link text.
999 An optional third parameter sets the link type. If not specified,
1000 it is an ordinary [[ikiwiki/WikiLink]].
1002 ### `add_autofile($$$)`
1004 Sometimes you may want to add a file to the `srcdir` as a result of content
1005 of other pages. For example, [[plugins/tag]] pages can be automatically
1006 created as needed. This function can be used to do that. 
1008 The three parameters are the filename to create (relative to the `srcdir`),
1009 the name of the plugin, and a callback function. The callback will be
1010 called if it is appropriate to automatically add the file, and should then
1011 take care of creating it, and doing anything else it needs to (such as
1012 checking it into revision control). Note that the callback may not always
1013 be called. For example, if an automatically added file is deleted by the
1014 user, ikiwiki will avoid re-adding it again.
1016 This function needs to be called during the scan hook, or earlier in the
1017 build process, in order to add the file early enough for it to be built.
1019 ## Miscellaneous
1021 ### Internal use pages
1023 Sometimes it's useful to put pages in the wiki without the overhead of
1024 having them be rendered to individual html files. Such internal use pages
1025 are collected together to form the RecentChanges page, for example.
1027 To make an internal use page, register a filename extension that starts
1028 with "_". Internal use pages cannot be edited with the web interface,
1029 generally shouldn't contain [[WikiLinks|ikiwiki/WikiLink]] or preprocessor directives (use
1030 either on them with extreme caution), and are not matched by regular
1031 PageSpecs glob patterns, but instead only by a special `internal()`
1032 [[ikiwiki/PageSpec]].
1034 ### RCS plugins
1036 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
1037 plugins. See [[RCS_details|rcs/details]] for some more info.
1039 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
1040 and the 'id' field is set to the name of the hook. For example:
1041         
1042         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
1043         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
1045 #### `rcs_update()`
1047 Updates the working directory with any remote changes.
1049 #### `rcs_prepedit($)`
1051 Is passed a file to prepare to edit. It can generate and return an arbitrary
1052 token, that will be passed into `rcs_commit` when committing. For example,
1053 it might return the current revision ID of the file, and use that
1054 information later when merging changes.
1056 #### `rcs_commit(@)`
1058 Passed named parameters: `file`, `message`, `token` (from `rcs_prepedit`),
1059 and `session` (optional).
1061 Should try to commit the file. Returns `undef` on *success* and a version
1062 of the page with the rcs's conflict markers on failure.
1064 #### `rcs_commit_staged(@)`
1066 Passed named parameters: `message`, and `session` (optional).
1068 Should commit all staged changes. Returns undef on success, and an
1069 error message on failure.
1071 Changes can be staged by calls to `rcs_add`, `rcs_remove`, and
1072 `rcs_rename`.
1074 #### `rcs_add($)`
1076 Adds the passed file to the archive. The filename is relative to the root
1077 of the srcdir.
1079 Note that this should not commit the new file, it should only
1080 prepare for it to be committed when rcs_commit (or `rcs_commit_staged`) is
1081 called. Note that the file may be in a new subdir that is not yet in
1082 to version control; the subdir can be added if so.
1084 #### `rcs_remove($)`
1086 Remove a file. The filename is relative to the root of the srcdir.
1088 Note that this should not commit the removal, it should only prepare for it
1089 to be committed when `rcs_commit` (or `rcs_commit_staged`) is called. Note
1090 that the new file may be in a new subdir that is not yet in version
1091 control; the subdir can be added if so.
1093 #### `rcs_rename($$)`
1095 Rename a file. The filenames are relative to the root of the srcdir.
1097 Note that this should not commit the rename, it should only
1098 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
1099 The new filename may be in a new subdir, that is not yet added to
1100 version control. If so, the subdir will exist already, and should
1101 be added to revision control.
1103 #### `rcs_recentchanges($)`
1105 Examine the RCS history and generate a list of recent changes.
1106 The parameter is how many changes to return.
1108 The data structure returned for each change is:
1110         {
1111                 rev => # the RCSs id for this commit
1112                 user => # user who made the change (may be an openid),
1113                 nickname => # short name for user (optional; not an openid),
1114                 
1115                 committype => # either "web" or the name of the rcs,
1116                 when => # time when the change was made,
1117                 message => [
1118                         { line => "commit message line 1" },
1119                         { line => "commit message line 2" },
1120                         # etc,
1121                 ],
1122                 pages => [
1123                         {
1124                                 page => # name of page changed,
1125                                 diffurl => # optional url to a diff of changes
1126                         },
1127                         # repeat for each page changed in this commit,
1128                 ],
1129         }
1131 #### `rcs_diff($)`
1133 The parameter is the rev from `rcs_recentchanges`.
1134 Should return a list of lines of the diff (including \n) in list
1135 context, and the whole diff in scalar context.
1137 #### `rcs_getctime($)`
1139 This is used to get the page creation time for a file from the RCS, by looking
1140 it up in the history.
1142 It's ok if this is not implemented, and throws an error.
1144 If the RCS cannot determine a ctime for the file, return 0.
1146 #### `rcs_getmtime($)`
1148 This is used to get the page modification time for a file from the RCS, by
1149 looking it up in the history.
1151 It's ok if this is not implemented, and throws an error.
1153 If the RCS cannot determine a mtime for the file, return 0.
1155 #### `rcs_receive()`
1157 This is called when ikiwiki is running as a pre-receive hook (or
1158 equivalent), and is testing if changes pushed into the RCS from an
1159 untrusted user should be accepted. This is optional, and doesn't make
1160 sense to implement for all RCSs.
1162 It should examine the incoming changes, and do any sanity 
1163 checks that are appropriate for the RCS to limit changes to safe file adds,
1164 removes, and changes. If something bad is found, it should exit
1165 nonzero, to abort the push. Otherwise, it should return a list of
1166 files that were changed, in the form:
1168         {
1169                 file => # name of file that was changed
1170                 action => # either "add", "change", or "remove"
1171                 path => # temp file containing the new file content, only
1172                         # needed for "add"/"change", and only if the file
1173                         # is an attachment, not a page
1174         }
1176 The list will then be checked to make sure that each change is one that
1177 is allowed to be made via the web interface.
1179 ### PageSpec plugins
1181 It's also possible to write plugins that add new functions to
1182 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
1183 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
1184 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
1185 two parameters: The name of the page being matched, and the thing to match
1186 against. It may also be passed additional, named parameters.
1188 It should return a IkiWiki::SuccessReason object if the match succeeds, or
1189 an IkiWiki::FailReason object if the match fails. If the match cannot be
1190 attempted at all, for any page, it can instead return an
1191 IkiWiki::ErrorReason object explaining why.
1193 When constructing these objects, you should also include information about
1194 of any pages whose contents or other metadata influenced the result of the
1195 match. Do this by passing a list of pages, followed by `deptype` values.
1197 For example, "backlink(foo)" is influenced by the contents of page foo;
1198 "link(foo)" and "title(bar)" are influenced by the contents of any page
1199 they match; "created_before(foo)" is influenced by the metadata of foo;
1200 while "glob(*)" is not influenced by the contents of any page.
1202 ### Sorting plugins
1204 Similarly, it's possible to write plugins that add new functions as
1205 [[ikiwiki/pagespec/sorting]] methods. To achieve this, add a function to
1206 the IkiWiki::SortSpec package named `cmp_foo`, which will be used when sorting
1207 by `foo` or `foo(...)` is requested.
1209 The names of pages to be compared are in the global variables `$a` and `$b`
1210 in the IkiWiki::SortSpec package. The function should return the same thing
1211 as Perl's `cmp` and `<=>` operators: negative if `$a` is less than `$b`,
1212 positive if `$a` is greater, or zero if they are considered equal. It may
1213 also raise an error using `error`, for instance if it needs a parameter but
1214 one isn't provided.
1216 The function will also be passed one or more parameters. The first is
1217 `undef` if invoked as `foo`, or the parameter `"bar"` if invoked as `foo(bar)`;
1218 it may also be passed additional, named parameters.
1220 ### Setup plugins
1222 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
1223 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
1224 and the rest of the file is passed to that module's import method.
1226 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
1227 can be used to configure ikiwiki in different ways. These modules should,
1228 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
1229 to a hash containing all the config items. They should also implement a
1230 `gendump` function.
1232 By the way, to parse a ikiwiki setup file and populate `%config`, a
1233 program just needs to do something like:
1234 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`
1236 ### Function overriding
1238 Sometimes using ikiwiki's pre-defined hooks is not enough. Your plugin
1239 may need to replace one of ikiwiki's own functions with a modified version,
1240 or wrap one of the functions.
1242 For example, your plugin might want to override `displaytime`, to change
1243 the html markup used when displaying a date. Or it might want to override
1244 `IkiWiki::formattime`, to change how a date is formatted. Or perhaps you
1245 want to override `bestlink` and change how ikiwiki deals with [[WikiLinks|ikiwiki/WikiLink]].
1247 By venturing into this territory, your plugin is becoming tightly tied to
1248 ikiwiki's internals. And it might break if those internals change. But
1249 don't let that stop you, if you're brave.
1251 Ikiwiki provides an `inject()` function, that is a powerful way to replace
1252 any function with one of your own. This even allows you to inject a
1253 replacement for an exported function, like `bestlink`. Everything that
1254 imports that function will get your version instead. Pass it the name of
1255 the function to replace, and a new function to call. 
1257 For example, here's how to replace `displaytime` with a version using HTML 5
1258 markup:
1260         inject(name => 'IkiWiki::displaytime', call => sub {
1261                 return "<time>".formattime(@_)."</time>";
1262         });
1264 Here's how to wrap `bestlink` with a version that tries to handle
1265 plural words:
1267         my $origbestlink=\&bestlink;
1268         inject(name => 'IkiWiki::bestlink', call => \&mybestlink);
1270         sub deplural ($) {
1271                 my $word=shift;
1272                 $word =~ s/e?s$//; # just an example :-)
1273                 return $word;
1274         }
1276         sub mybestlink ($$) {
1277                 my $page=shift;
1278                 my $link=shift;
1279                 my $ret=$origbestlink->($page, $link);
1280                 if (! length $ret) {
1281                         $ret=$origbestlink->($page, deplural($link));
1282                 }
1283                 return $ret;
1284         }
1286 ### Javascript
1288 Some plugins use javascript to make ikiwiki look a bit more web-2.0-ish.
1290 All javascript code should be put in `.js` files in the `javascript`
1291 underlay, and plugins using those files can enable use of the underlay by
1292 calling `add_underlay("javascript");` in their `import` function.
1294 You'll have to arrange for `<script>` tags to be added to the pages that
1295 use your javascript. This can be done using a `format` hook.
1297 Ikiwiki provides some utility functions in `ikiwiki.js`, for use by other
1298 javascript code. These include:
1300 #### `getElementsByClass(cls, node, tag)` 
1302 Returns an array of elements with the given class. The node and tag are
1303 optional and define what document node and element names to search.
1305 #### `hook(name, call)`
1307 The function `call` will be run as part of the hook named `name`.
1309 Note that to hook into `window.onload`, you can use the `onload' hook.
1311 #### `run_hooks(name)`
1313 Runs the hooks with the specified name.