]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/write.mdwn
Added a comment
[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
35 [[`refresh`|plugins/write#refresh]] hook. Then it checks the wiki's source to
36 find new or changed pages. The [[`needsbuild`|plugins/write#needsbuild]] hook
37 is then called to allow manipulation of the list of pages that need to be
38 built.
40 Now that it knows what pages it needs to build, ikiwiki runs two compile
41 passes. First, it runs [[`scan`|plugins/write#scan]] hooks, which collect
42 metadata about the pages. Then it runs a page rendering pipeline, by calling
43 in turn these hooks: [[`filter`|plugins/write#filter]],
44 [[`preprocess`|plugins/write#preprocess]],
45 [[`linkify`|plugins/write#linkify]], [[`htmlize`|plugins/write#htmlize]],
46 [[`indexhtml`|plugins/write#indexhtml]],
47 [[`pagetemplate`|plugins/write#pagetemplate]],
48 [[`sanitize`|plugins/write#sanitize]], [[`format`|plugins/write#format]].
50 After all necessary pages are built, it calls the
51 [[`changes`|plugins/write#changes]] hook. Finally, if a page was deleted, the
52 [[`delete`|plugins/write#delete]] hook is called, and the files that page had
53 previously produced are removed.
55 ### cgi
57 The flow between hooks when ikiwiki is run as a cgi is best illustrated by
58 an example.
60 Alice browses to a page and clicks Edit.
62 * Ikiwiki is run as a cgi. It assigns Alice a session cookie, and, by calling
63   the [[`auth`|plugins/write#auth]] hooks, sees that she is not yet logged in.
64 * The [[`sessioncgi`|plugins/write#sessioncgi]] hooks are then called, and one
65   of them, from the [[editpage]] plugin, notices that the cgi has been told
66   "do=edit".
67 * The [[editpage]] plugin calls the [[`canedit`|plugins/write#canedit]] hook
68   to check if this page edit is allowed. The [[signinedit]] plugin has a hook
69   that says not: Alice is not signed in.
70 * The [[signinedit]] plugin then launches the signin process. A signin page is
71   built by calling the [[`formbuilder_setup`|plugins/write#formbuilder]]
72   hook.
74 Alice signs in with her openid.
76 * The [[openid]] plugin's [[`formbuilder`|plugins/write#formbuilder]] hook
77   sees that an openid was entered in the signin form, and redirects to Alice's
78   openid provider.
79 * Alice's openid provider calls back to ikiwiki. The [[openid]] plugin has an
80   [[`auth`|plugins/write#auth]] hook that finishes the openid signin process.
81 * Signin complete, ikiwiki returns to what Alice was doing before; editing
82   a page.
83 * Now all the [[`canedit`|plugins/write#canedit]] hooks are happy. The
84   [[editpage]] plugin calls
85   [[`formbuilder_setup`|plugins/write#formbuilder]] to display the page
86   editing form.
88 Alice saves her change to the page.
90 * The [[editpage]] plugin's [[`formbuilder`|plugins/write#formbuilder]] hook
91   sees that the Save button was pressed, and calls the
92   [[`checkcontent`|plugins/write#checkcontent]] and
93   [[`editcontent`|plugins/write#editcontent]] hooks.  Then it saves the page
94   to disk, and branches into the compiler part of ikiwiki to refresh the wiki.
96 ## Types of plugins
98 Most ikiwiki [[plugins]] are written in perl, like ikiwiki. This gives the
99 plugin full access to ikiwiki's internals, and is the most efficient.
100 However, plugins can actually be written in any language that supports XML
101 RPC. These are called [[external]] plugins.
103 A plugin written in perl is a perl module, in the `IkiWiki::Plugin`
104 namespace. The name of the plugin is typically in lowercase, such as
105 `IkiWiki::Plugin::inline`. Ikiwiki includes a `IkiWiki::Plugin::skeleton`
106 that can be fleshed out to make a useful plugin.
107 `IkiWiki::Plugin::pagecount` is another simple example. All perl plugins
108 should `use IkiWiki` to import the ikiwiki plugin interface. It's a good
109 idea to include the version number of the plugin interface that your plugin
110 expects: `use IkiWiki 3.00`.
112 An external plugin is an executable program. It can be written in any
113 language. Its interface to ikiwiki is via XML RPC, which it reads from
114 ikiwiki on its standard input, and writes to ikiwiki on its standard
115 output. For more details on writing external plugins, see [[external]].
117 Despite these two types of plugins having such different interfaces,
118 they're the same as far as how they hook into ikiwiki. This document will
119 explain how to write both sorts of plugins, albeit with an emphasis on perl
120 plugins.
122 ## Plugin interface
124 To import the ikiwiki plugin interface:
126         use IkiWiki '3.00';
128 This will import several variables and functions into your plugin's
129 namespace. These variables and functions are the ones most plugins need,
130 and a special effort will be made to avoid changing them in incompatible
131 ways, and to document any changes that have to be made in the future.
133 Note that IkiWiki also provides other variables and functions that are not
134 exported by default. No guarantee is made about these in the future, so if
135 it's not exported, the wise choice is to not use it.
137 ## Registering plugins
139 Plugins should, when imported, call `hook()` to hook into ikiwiki's
140 processing. The function uses named parameters, and use varies depending on
141 the type of hook being registered -- see below. A plugin can call
142 the function more than once to register multiple hooks.
144 All calls to `hook()` should be passed a "type" parameter, which gives the
145 type of hook, a "id" parameter, which should be a unique string for this
146 plugin, and a "call" parameter, which tells what function to call for the
147 hook.
149 An optional "last" parameter, if set to a true value, makes the hook run
150 after all other hooks of its type, and an optional "first" parameter makes
151 it run first. Useful if the hook depends on some other hook being run first.
153 ## Types of hooks
155 In roughly the order they are called.
157 ### getopt
159         hook(type => "getopt", id => "foo", call => \&getopt);
161 This allows for plugins to perform their own processing of command-line
162 options and so add options to the ikiwiki command line. It's called during
163 command line processing, with `@ARGV` full of any options that ikiwiki was
164 not able to process on its own. The function should process any options it
165 can, removing them from `@ARGV`, and probably recording the configuration
166 settings in `%config`. It should take care not to abort if it sees
167 an option it cannot process, and should just skip over those options and
168 leave them in `@ARGV`.
170 ### checkconfig
172         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
174 This is useful if the plugin needs to check for or modify ikiwiki's
175 configuration. It's called early in the startup process. `%config`
176 is populated at this point, but other state has not yet been loaded.
177 The function is passed no values. It's ok for the function to call
178 `error()` if something isn't configured right.
180 ### <a name="refresh">refresh</a>
182         hook(type => "refresh", id => "foo", call => \&refresh);
184 This hook is called just before ikiwiki scans the wiki for changed files.
185 It's useful for plugins that need to create or modify a source page. The
186 function is passed no values.
188 ### <a name="needsbuild">needsbuild</a>
190         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
192 This allows a plugin to observe or even manipulate the list of files that
193 need to be built when the wiki is refreshed. 
195 As its first parameter, the function is passed a reference to an array of
196 files that will be built. It should return an array reference that is a
197 modified version of its input. It can add or remove files from it.
199 The second parameter passed to the function is a reference to an array of
200 files that have been deleted.
202 ### <a name="scan">scan</a>
204         hook(type => "scan", id => "foo", call => \&scan);
206 This hook is called early in the process of building the wiki, and is used
207 as a first pass scan of the page, to collect metadata about the page. It's
208 mostly used to scan the page for [[WikiLinks|ikiwiki/WikiLink]], and add
209 them to `%links`. Present in IkiWiki 2.40 and later.
211 The function is passed named parameters "page" and "content". Its return
212 value is ignored.
214 ### <a name="readtemplate">readtemplate</a>
216         hook(type => "readtemplate", id => "foo", call => \&readtemplate);
218 Runs on the raw source of a page or `*.tmpl` file that is being
219 used as a template, before it is parsed by [[!cpan HTML::Template]].
220 For instance, the [[plugins/templatebody]] plugin uses this to return
221 the content of the [[ikiwiki/directive/templatebody]] directive (if there
222 is one) instead of the page's full content.
224 The function is passed named parameters:
226 * `id`: the name under which the template was looked up,
227   such as `page.tmpl` or `note`
228 * `page`: the name of the template as a page or attachment in the wiki,
229   such as `templates/note`, or `undef` if it's outside the wiki (e.g. in
230   `/usr/share/ikiwiki/templates`)
231 * `content`: the content of the corresponding file
232 * `untrusted`: true if the template was loaded from the wiki or an underlay,
233   false if it was loaded from a trusted location
235 It should return the replacement content.
237 ### <a name="filter">filter</a>
239         hook(type => "filter", id => "foo", call => \&filter);
241 Runs on the full raw source of a page, before anything else touches it, and
242 can make arbitrary changes. The function is passed named parameters "page",
243 "destpage", and "content". It should return the filtered content.
245 ### <a name="preprocess">preprocess</a>
247 Adding a preprocessor [[ikiwiki/directive]] is probably the most common use
248 of a plugin.
250         hook(type => "preprocess", id => "foo", call => \&preprocess);
252 Replace "foo" with the command name that will be used for the preprocessor
253 directive.
255 Each time the directive is processed, the referenced function (`preprocess`
256 in the example above) is called. Whatever the function returns goes onto
257 the page in place of the directive. Or, if the function aborts using
258 `error()`, the directive will be replaced with the error message.
260 The function is passed named parameters. First come the parameters set
261 in the preprocessor directive. These are passed in the same order as
262 they're in the directive, and if the preprocessor directive contains a bare
263 parameter (example: `\[[!foo param]]`), that parameter will be passed with
264 an empty value.
266 After the parameters from the preprocessor directive some additional ones
267 are passed: A "page" parameter gives the name of the page that embedded the
268 preprocessor directive, while a "destpage" parameter gives the name of the
269 page the content is going to (different for inlined pages), and a "preview"
270 parameter is set to a true value if the page is being previewed.
272 If `hook` is passed an optional "scan" parameter, set to a true value, this
273 makes the hook be called during the preliminary scan that ikiwiki makes of
274 updated pages, before begining to render pages. This should be done if the
275 hook modifies data in `%links` (typically by calling `add_link`). Note that
276 doing so will make the hook be run twice per page build, so avoid doing it
277 for expensive hooks. (As an optimisation, if your preprocessor hook is
278 called in a void context, you can assume it's being run in scan mode, and
279 avoid doing expensive things at that point.)
281 Note that if the [[htmlscrubber]] is enabled, html in
282 preprocessor [[ikiwiki/directive]] output is sanitised, which may limit what
283 your plugin can do. Also, the rest of the page content is not in html
284 format at preprocessor time. Text output by a preprocessor directive will
285 be linkified and passed through markdown (or whatever engine is used to
286 htmlize the page) along with the rest of the page.
288 ### <a name="linkify">linkify</a>
290         hook(type => "linkify", id => "foo", call => \&linkify);
292 This hook is called to convert [[WikiLinks|ikiwiki/WikiLink]] on the page into html
293 links. The function is passed named parameters "page", "destpage", and
294 "content". It should return the linkified content.  Present in IkiWiki 2.40
295 and later.
297 Plugins that implement linkify must also implement a scan hook, that scans
298 for the links on the page and adds them to `%links` (typically by calling
299 `add_link`).
301 ### <a name="htmlize">htmlize</a>
303         hook(type => "htmlize", id => "ext", call => \&htmlize);
305 Runs on the source of a page and turns it into html. The id parameter
306 specifies the filename extension that a file must have to be htmlized using
307 this plugin. This is how you can add support for new and exciting markup
308 languages to ikiwiki.
310 The function is passed named parameters: "page" and "content" and should
311 return the htmlized content.
313 If `hook` is passed an optional "keepextension" parameter, set to a true
314 value, then the extension will not be stripped from the source filename when
315 generating the page.
317 If `hook` is passed an optional "noextension" parameter, set to a true
318 value, then the id parameter specifies not a filename extension, but
319 a whole filename that can be htmlized. This is useful for files
320 like `Makefile` that have no extension.
322 If `hook` is passed an optional "longname" parameter, this value is used
323 when prompting a user to choose a page type on the edit page form.
325 ### <a name="indexhtml">indexhtml</a>
327         hook(type => "indexhtml", id => "foo", call => \&indexhtml);
329 This hook is called once the page has been converted to html (but before
330 the generated html is put in a template). The most common use is to
331 update search indexes. Added in ikiwiki 2.54.
333 The function is passed named parameters "page", "destpage", and "content".
334 Its return value is ignored.
336 ### <a name="pagetemplate">pagetemplate</a>
338         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
340 [[Templates]] are filled out for many different things in
341 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
342 a cgi. This hook allows modifying the variables available on those
343 templates. The function is passed named parameters. The "page" and
344 "destpage" parameters are the same as for a preprocess hook. The "template"
345 parameter is a [[!cpan HTML::Template]] object that is the template that
346 will be used to generate the page. The function can manipulate that
347 template object.
349 The most common thing to do is probably to call `$template->param()` to add
350 a new custom parameter to the template.
352 ### templatefile
354         hook(type => "templatefile", id => "foo", call => \&templatefile);
356 This hook allows plugins to change the [[template|templates]] that is
357 used for a page in the wiki. The hook is passed a "page" parameter, and
358 should return the name of the template file to use (relative to the
359 template directory), or undef if it doesn't want to change the default
360 ("page.tmpl").
362 ### pageactions
364         hook(type => "pageactions", id => "foo", call => \&pageactions);
366 This hook allows plugins to add arbitrary actions to the action bar on a
367 page (next to Edit, RecentChanges, etc). The hook is passed a "page"
368 parameter, and can return a list of html fragments to add to the action
369 bar.
371 ### <a name="sanitize">sanitize</a>
373         hook(type => "sanitize", id => "foo", call => \&sanitize);
375 Use this to implement html sanitization or anything else that needs to
376 modify the body of a page after it has been fully converted to html.
378 The function is passed named parameters: "page", "destpage", and "content",
379 and should return the sanitized content.
381 ### <a name="format">format</a>
383         hook(type => "format", id => "foo", call => \&format);
385 The difference between format and sanitize is that sanitize only acts on
386 the page body, while format can modify the entire html page including the
387 header and footer inserted by ikiwiki, the html document type, etc. (It
388 should not rely on always being passed the entire page, as it won't be
389 when the page is being previewed.)
391 The function is passed named parameters: "page" and "content", and 
392 should return the formatted content.
394 ### build_affected
396         hook(type => "build_affected", id => "foo", call => \&build_affected);
398 This hook is called after the directly changed pages have been built,
399 and can cause extra pages to be built. If links and backlinks were provided
400 by a plugin, this would be where that plugin would rebuild pages whose
401 backlinks have changed, for instance. The [[trail]] plugin uses this hook
402 to rebuild pages whose next or previous page has changed.
404 The function should currently ignore its parameters. It returns a list with
405 an even number of items (a hash in list context), where the first item of
406 each pair is a page name to be rebuilt (if it was not already rebuilt), and
407 the second is a log message resembling
408 `building plugins/write because the phase of the moon has changed`.
410 ### <a name="delete">delete</a>
412         hook(type => "delete", id => "foo", call => \&delete);
414 After a page or pages is removed from the wiki, the referenced function
415 is called, and passed the names of the source files that were removed.
417 ### rendered
419         hook(type => "rendered", id => "foo", call => \&rendered);
421 After ikiwiki renders a change or addition (but not deletion) to the
422 wiki, the referenced function is called, and passed the names of the
423 source files that were rendered.
425 (This hook used to be called "change", but that was not accurate.
426 For now, plugins using the old hook name will still work.)
428 ### <a name="changes">changes</a>
430         hook(type => "changes", id => "foo", call => \&changes);
432 After ikiwiki renders changes to the wiki, the referenced function is
433 called, and passed the names of the source files that were added, modified,
434 or deleted.
436 ### cgi
438         hook(type => "cgi", id => "foo", call => \&cgi);
440 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
441 called in turn, and passed a CGI object. The hook should examine the
442 parameters, and if it will handle this CGI request, output a page
443 (including the http headers) and terminate the program.
445 Note that cgi hooks are called as early as possible, before any ikiwiki
446 state is loaded, and with no session information.
448 ### <a name="auth">auth</a>
450         hook(type => "auth", id => "foo", call => \&auth);
452 This hook can be used to implement an authentication method. When a user
453 needs to be authenticated, each registered auth hook is called in turn, and
454 passed a CGI object and a session object. 
456 If the hook is able to authenticate the user, it should set the session
457 object's "name" parameter to the authenticated user's name. Note that
458 if the name is set to the name of a user who is not registered,
459 a basic registration of the user will be automatically performed.
461 Auth plugins can use the loginselector helper plugin to let the user
462 select which authentication method to use.
464 ### <a name="sessioncgi">sessioncgi</a>
466         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
468 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
469 is only run once a session object is available. It is passed both a CGI
470 object and a session object. To check if the user is in fact signed in, you
471 can check if the session object has a "name" parameter set.
473 ### <a name="canedit">canedit</a>
475         hook(type => "canedit", id => "foo", call => \&canedit);
477 This hook can be used to implement arbitrary access methods to control when
478 a page can be edited using the web interface (commits from revision control
479 bypass it). When a page is edited, each registered canedit hook is called
480 in turn, and passed the page name, a CGI object, and a session object.
482 If the hook has no opinion about whether the edit can proceed, return
483 `undef`, and the next plugin will be asked to decide. If edit can proceed,
484 the hook should return "". If the edit is not allowed by this hook, the
485 hook should return an error message for the user to see, or a function 
486 that can be run to log the user in or perform other action necessary for
487 them to be able to edit the page.
489 This hook should avoid directly redirecting the user to a signin page,
490 since it's sometimes used to test to see which pages in a set of pages a
491 user can edit.
493 ### canremove
495         hook(type => "canremove", id => "foo", call => \&canremove);
497 This hook can be used to implement arbitrary access methods to control
498 when a page can be removed using the web interface (commits from
499 revision control bypass it). It works exactly like the `canedit` hook,
500 but is passed the named parameters `cgi` (a CGI object), `session`
501 (a session object) and `page` (the page subject to deletion).
503 ### canrename
505         hook(type => "canrename", id => "foo", call => \&canrename);
507 This hook can be used to implement arbitrary access methods to control when
508 a page can be renamed using the web interface (commits from revision control
509 bypass it). It works exactly like the `canedit` hook,
510 but is passed the named parameters `cgi` (a CGI object), `session` (a
511 session object), `src`, `srcfile`, `dest` and `destfile`.
513 ### <a name="checkcontent">checkcontent</a>
514         
515         hook(type => "checkcontent", id => "foo", call => \&checkcontent);
517 This hook is called to check the content a user has entered on a page,
518 before it is saved, and decide if it should be allowed.
520 It is passed named parameters: `content`, `page`, `cgi`, and `session`. If
521 the content the user has entered is a comment, it may also be passed some
522 additional parameters: `author`, `url`, and `subject`. The `subject`
523 parameter may also be filled with the user's comment about the change.
525 Note: When the user edits an existing wiki page, this hook is also
526 passed a `diff` named parameter, which will include only the lines
527 that they added to the page, or modified.
529 The hook should return `undef` on success. If the content is disallowed, it
530 should return a message stating what the problem is, or a function
531 that can be run to perform whatever action is necessary to allow the user
532 to post the content.
534 ### <a name="editcontent">editcontent</a>
536         hook(type => "editcontent", id => "foo", call => \&editcontent);
538 This hook is called when a page is saved (or previewed) using the web
539 interface. It is passed named parameters: `content`, `page`, `cgi`, and
540 `session`. These are, respectively, the new page content as entered by the
541 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
543 It can modify the content as desired, and should return the content.
545 ### <a name="formbuilder">formbuilder</a>
547         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
548         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
550 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
551 CGI::FormBuilder]] to generate web forms. These hooks are passed named
552 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
553 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
554 reference to an array of names of buttons to go on the form.
556 Each time a form is set up, the `formbuilder_setup` hook is called.
557 Typically the `formbuilder_setup` hook will check the form's title, and if
558 it's a form that it needs to modify, will call various methods to
559 add/remove/change fields, tweak the validation code for the fields, etc. It
560 will not validate or display the form.
562 Just before a form is displayed to the user, the `formbuilder` hook is
563 called. It can be used to validate the form, but should not display it.
565 ### savestate
567         hook(type => "savestate", id => "foo", call => \&savestate);
569 This hook is called whenever ikiwiki normally saves its state, just before
570 the state is saved. The function can save other state, modify values before
571 they're saved, etc.
573 ### renamepage
575         hook(type => "renamepage", id => "foo", call => \&renamepage);
577 This hook is called by the [[plugins/rename]] plugin when it renames
578 something, once per page linking to the renamed page's old location.
579 The hook is passed named parameters: `page`, `oldpage`, `newpage`, and
580 `content`, and should try to modify the content of `page` to reflect
581 the name change. For example, by converting links to point to the
582 new page.
584 ### rename
586         hook(type => "rename", id => "foo", call => \&rename);
588 When a page or set of pages is renamed, the referenced function is
589 called for every page, and is passed named parameters:
591 * `torename`: a reference to a hash with keys: `src`, `srcfile`,
592   `dest`, `destfile`, `required`.
593 * `cgi`: a CGI object
594 * `session`: a session object.
596 Such a hook function returns any additional rename hashes it wants to
597 add. This hook is applied recursively to returned additional rename
598 hashes, so that it handles the case where two plugins use the hook:
599 plugin A would see when plugin B adds a new file to be renamed.
601 ### getsetup
603         hook(type => "getsetup", id => "foo", call => \&getsetup);
605 This hooks is not called during normal operation, but only when setting up 
606 the wiki, or generating a setup file. Plugins can use this hook to add
607 configuration options.
609 The hook is passed no parameters. It returns data about the configuration
610 options added by the plugin. It can also check if the plugin is usable, and
611 die if not, which will cause the plugin to not be offered in the configuration
612 interface.
614 The data returned is a list of `%config` options, followed by a hash
615 describing the option. There can also be an item named "plugin", which
616 describes the plugin as a whole. For example:
618                 return
619                         plugin => {
620                                 description => "description of this plugin",
621                                 safe => 1,
622                                 rebuild => 1,
623                                 section => "misc",
624                         },
625                         option_foo => {
626                                 type => "boolean",
627                                 description => "enable foo?",
628                                 advanced => 1,
629                                 safe => 1,
630                                 rebuild => 1,
631                         },
632                         option_bar => {
633                                 type => "string",
634                                 example => "hello",
635                                 description => "option bar",
636                                 safe => 1,
637                                 rebuild => 0,
638                         },
640 * `type` can be "boolean", "string", "integer", "pagespec",
641   or "internal" (used for values that are not user-visible). The type is
642   the type of the leaf values;  the `%config` option may be an array or
643   hash of these.
644 * `example` can be set to an example value.
645 * `description` is a short description of the option.
646 * `link` is a link to further information about the option. This can either
647   be a [[ikiwiki/WikiLink]], or an url.
648 * `htmldescription` is displayed instead of the description by websetup.
649 * `advanced` can be set to true if the option is more suitable for advanced
650   users.
651 * `safe` should be false if the option should not be displayed in unsafe
652   configuration methods, such as the web interface. Anything that specifies
653   a command to run, a path on disk, or a regexp should be marked as unsafe.
654   If a plugin is marked as unsafe, that prevents it from being
655   enabled/disabled.
656 * `rebuild` should be true if changing the option (or enabling/disabling
657   the plugin) will require a wiki rebuild, false if no rebuild is needed,
658   and undef if a rebuild could be needed in some circumstances, but is not
659   strictly required.
660 * `section` can optionally specify which section in the config file
661   the plugin fits in. The convention is to name the sections the
662   same as the tags used for [[plugins]] on this wiki.
664 ### genwrapper
666         hook(type => "genwrapper", id => "foo", call => \&genwrapper);
668 This hook is used to inject C code (which it returns) into the `main`
669 function of the ikiwiki wrapper when it is being generated. 
671 The code runs before anything else -- in particular it runs before
672 the suid wrapper has sanitized its environment.
674 ### disable
676         hook(type => "disable", id => "foo", call => \&disable);
678 This hook is only run when a previously enabled plugin gets disabled
679 during ikiwiki setup. Plugins can use this to perform cleanups.
681 ## Exported variables
683 Several variables are exported to your plugin when you `use IkiWiki;`
685 ### `%config`
687 A plugin can access the wiki's configuration via the `%config`
688 hash. The best way to understand the contents of the hash is to look at
689 your ikiwiki setup file, which sets the hash content to configure the wiki.
691 ### `%pagestate`
693 The `%pagestate` hash can be used by plugins to save state that they will need
694 next time ikiwiki is run. The hash holds per-page state, so to set a value,
695 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
696 use `$pagestate{$page}{$id}{$key}`.
698 The `$value` can be anything that perl's Storable module is capable of
699 serializing. `$key` can be any string you like, but `$id` must be the same
700 as the "id" parameter passed to `hook()` when registering the plugin. This
701 is so ikiwiki can know when to delete pagestate for plugins that are no
702 longer used.
704 When pages are deleted, ikiwiki automatically deletes their pagestate too.
706 Note that page state does not persist across wiki rebuilds, only across
707 wiki updates.
709 ### `%wikistate`
711 The `%wikistate` hash can be used by a plugin to store persistant state
712 that is not bound to any one page. To set a value, use
713 `$wikistate{$id}{$key}=$value`, where `$value` is anything Storable can
714 serialize, `$key` is any string you like, and `$id` must be the same as the
715 "id" parameter passed to `hook()` when registering the plugin, so that the
716 state can be dropped if the plugin is no longer used.
718 ### `%links`
720 The `%links` hash can be used to look up the names of each page that
721 a page links to. The name of the page is the key; the value is an array
722 reference. Do not modify this hash directly; call `add_link()`.
724         $links{"foo"} = ["bar", "baz"];
726 ### `%typedlinks`
728 The `%typedlinks` hash records links of specific types. Do not modify this
729 hash directly; call `add_link()`. The keys are page names, and the values
730 are hash references. In each page's hash reference, the keys are link types
731 defined by plugins, and the values are hash references with link targets
732 as keys, and 1 as a dummy value, something like this:
734         $typedlinks{"foo"} = {
735                 tag => { short_word => 1, metasyntactic_variable => 1 },
736                 next_page => { bar => 1 },
737         };
739 Ordinary [[WikiLinks|ikiwiki/WikiLink]] appear in `%links`, but not in
740 `%typedlinks`.
742 ### `%pagesources`
744 The `%pagesources` hash can be used to look up the source filename
745 of a page. So the key is the page name, and the value is the source
746 filename. Do not modify this hash.
748 Attachments also appear in this hash, with the same key and value.
750         $pagesources{"foo"} = "foo.mdwn";
751         $pagesources{"logo/ikiwiki.png"} = "logo/ikiwiki.png";
754 ### `%destsources`
756 The `%destsources` hash records the name of the source file used to
757 create each destination file. The key is the output filename (ie,
758 "foo/index.html"), and the value is the name of the page that it was built
759 from (eg, "foo"). Note that a single source file may create multiple
760 destination files. Do not modify this hash directly; call `will_render()`.
762 Attachments also appear in this hash, with the same key and value.
764         $destsources{"foo/index.html"} = "foo";
765         $destsources{"logo/ikiwiki.png"} = "logo/ikiwiki.png";
767 ## Library functions
769 Several functions are exported to your plugin when you `use IkiWiki;`
771 ### `hook(@)`
773 Hook into ikiwiki's processing. See the discussion of hooks above.
775 Note that in addition to the named parameters described above, a parameter
776 named `no_override` is supported, If it's set to a true value, then this hook
777 will not override any existing hook with the same id. This is useful if
778 the id can be controled by the user.
780 ### `debug($)`
782 Logs a debugging message. These are supressed unless verbose mode is turned
783 on.
785 ### `error($;$)`
787 Aborts with an error message. If the second parameter is passed, it is a
788 function that is called after the error message is printed, to do any final
789 cleanup.
791 If called inside a preprocess hook, error() does not abort the entire
792 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
793 a version containing the error message.
795 In other hooks, error() is a fatal error, so use with care. Try to avoid
796 dying on bad input when building a page, as that will halt
797 the entire wiki build and make the wiki unusable.
799 ### `template($;@)`
801 Creates and returns a [[!cpan HTML::Template]] object. (In a list context,
802 returns the parameters needed to construct the obhect.) 
804 The first parameter is the name of the template file. The optional remaining
805 parameters are passed to `HTML::Template->new`.
807 Normally, the template file is first looked for in the templates/ subdirectory
808 of the srcdir. Failing that, it is looked for in the templatedir.
810 Wiki pages can be used as templates. This should be done only for templates
811 which it is safe to let wiki users edit. Enable it by passing a filename
812 with no ".tmpl" extension. Template pages are normally looked for in
813 the templates/ directory. If the page name starts with "/", a page
814 elsewhere in the wiki can be used.
816 If the template is not found, or contains a syntax error, an error is thrown.
818 ### `template_depends($$;@)`
820 Use this instead of `template()` if the content of a template is being
821 included into a page. This causes the page to depend on the template,
822 so it will be updated if the template is modified.
824 Like `template()`, except the second parameter is the page.
826 ### `htmlpage($)`
828 Passed a page name, returns the base name that will be used for a the html
829 page created from it. (Ie, it appends ".html".)
831 Use this when constructing the filename of a html file. Use `urlto` when
832 generating a link to a page.
834 ### `pagespec_match_list($$;@)`
836 Passed a page name, and [[ikiwiki/PageSpec]], returns a list of pages
837 in the wiki that match the [[ikiwiki/PageSpec]]. 
839 The page will automatically be made to depend on the specified
840 [[ikiwiki/PageSpec]], so `add_depends` does not need to be called. This
841 is often significantly more efficient than calling `add_depends` and
842 `pagespec_match` in a loop. You should use this anytime a plugin
843 needs to match a set of pages and do something based on that list.
845 Unlike pagespec_match, this may throw an error if there is an error in
846 the pagespec.
848 Additional named parameters can be specified:
850 * `deptype` optionally specifies the type of dependency to add. Use the
851   `deptype` function to generate a dependency type.
852 * `filter` is a reference to a function, that is called and passed a page,
853   and returns true if the page should be filtered out of the list.
854 * `sort` specifies a sort order for the list. See
855   [[ikiwiki/PageSpec/sorting]] for the avilable sort methods. Note that
856   if a sort method is specified that depends on the
857   page content (such as 'meta(foo)'), the deptype needs to be set to
858   a content dependency.
859 * `reverse` if true, sorts in reverse.
860 * `num` if nonzero, specifies the maximum number of matching pages that
861   will be returned.
862 * `list` makes it only match amoung the specified list of pages.
863   Default is to match amoung all pages in the wiki.
865 Any other named parameters are passed on to `pagespec_match`, to further
866 limit the match.
868 ### `add_depends($$;$)`
870 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
872 By default, dependencies are full content dependencies, meaning that the
873 page will be updated whenever anything matching the PageSpec is modified.
874 This can be overridden by passing a `deptype` value as the third parameter.
876 ### `pagespec_match($$;@)`
878 Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
879 [[ikiwiki/PageSpec]] matches the page.
881 Note that the return value is overloaded. If stringified, it will be a
882 message indicating why the PageSpec succeeded, or failed, to match the
883 page.
885 Additional named parameters can be passed, to further limit the match.
886 The most often used is "location", which specifies the location the
887 PageSpec should match against. If not passed, relative PageSpecs will match
888 relative to the top of the wiki.
890 ### `deptype(@)`
892 Use this function to generate ikiwiki's internal representation of a
893 dependency type from one or more of these keywords:
895 * `content` is the default. Any change to the content
896   of a page triggers the dependency.
897 * `presence` is only triggered by a change to the presence
898   of a page.
899 * `links` is only triggered by a change to the links of a page.
900   This includes when a link is added, removed, or changes what
901   it points to due to other changes. It does not include the
902   addition or removal of a duplicate link.
904 If multiple types are specified, they are combined.
906 ### `bestlink($$)`
908 Given a page and the text of a link on the page, determine which
909 existing page that link best points to. Prefers pages under a
910 subdirectory with the same name as the source page, failing that
911 goes down the directory tree to the base looking for matching
912 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
914 ### `htmllink($$$;@)`
916 Many plugins need to generate html links and add them to a page. This is
917 done by using the `htmllink` function. The usual way to call
918 `htmllink` is:
920         htmllink($page, $page, $link)
922 Why is `$page` repeated? Because if a page is inlined inside another, and a
923 link is placed on it, the right way to make that link is actually:
925         htmllink($page, $destpage, $link)
927 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
928 some of the hook functions above; the ones that are not passed it are not used
929 during inlining and don't need to worry about this issue.
931 After the three required parameters, named parameters can be used to
932 control some options. These are:
934 * noimageinline - set to true to avoid turning links into inline html images
935 * forcesubpage  - set to force a link to a subpage
936 * linktext - set to force the link text to something
937 * anchor - set to make the link include an anchor
938 * rel - set to add a rel attribute to the link
939 * class - set to add a css class to the link
940 * title - set to add a title attribute to the link
942 ### `readfile($;$)`
944 Given a filename, reads and returns the entire file.
946 The optional second parameter, if set to a true value, makes the file be read
947 in binary mode.
949 A failure to read the file will result in it dying with an error.
951 ### `writefile($$$;$$)`
953 Given a filename, a directory to put it in, and the file's content,
954 writes a file. 
956 The optional fourth parameter, if set to a true value, makes the file be
957 written in binary mode.
959 The optional fifth parameter can be used to pass a function reference that
960 will be called to handle writing to the file. The function will be called
961 and passed a file descriptor it should write to, and an error recovery
962 function it should call if the writing fails. (You will not normally need to
963 use this interface.)
965 A failure to write the file will result in it dying with an error.
967 If the destination directory doesn't exist, it will first be created.
969 The filename and directory are separate parameters because of
970 some security checks done to avoid symlink attacks. Before writing a file,
971 it checks to make sure there's not a symlink with its name, to avoid
972 following the symlink. If the filename parameter includes a subdirectory
973 to put the file in, it also checks if that subdirectory is a symlink, etc.
974 The directory parameter, however, is not checked for symlinks. So,
975 generally the directory parameter is a trusted toplevel directory like
976 the srcdir or destdir, and any subdirectories of this are included in the
977 filename parameter.
979 ### `will_render($$)`
981 Given a page name and a destination file name (not including the base
982 destination directory), register that the page will result in that file
983 being rendered. 
985 It's important to call this before writing to any file in the destination
986 directory, and it's important to call it consistently every time, even if
987 the file isn't really written this time -- unless you delete any old
988 version of the file. In particular, in preview mode, this should still be
989 called even if the file isn't going to be written to during the preview.
991 Ikiwiki uses this information to automatically clean up rendered files when
992 the page that rendered them goes away or is changed to no longer render
993 them. will_render also does a few important security checks.
995 ### `pagetype($)`
997 Given the name of a source file, returns the type of page it is, if it's
998 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
1000 ### `pagename($)`
1002 Given the name of a source file, returns the name of the wiki page
1003 that corresponds to that file.
1005 ### `pagetitle($)`
1007 Give the name of a wiki page, returns a version suitable to be displayed as
1008 the page's title. This is accomplished by de-escaping escaped characters in
1009 the page name. "_" is replaced with a space, and '__NN__' is replaced by 
1010 the UTF character with code NN.
1012 ### `titlepage($)`
1014 This performs the inverse of `pagetitle`, ie, it converts a page title into
1015 a wiki page name.
1017 ### `linkpage($)`
1019 This converts text that could have been entered by the user as a
1020 [[ikiwiki/WikiLink]] into a wiki page name.
1022 ### `srcfile($;$)`
1024 Given the name of a source file in the wiki, searches for the file in
1025 the source directory and the underlay directories (most recently added
1026 underlays first), and returns the full path to the first file found.
1028 Normally srcfile will fail with an error message if the source file cannot
1029 be found. The second parameter can be set to a true value to make it return
1030 undef instead.
1032 ### `add_underlay($)`
1034 Adds a directory to the set of underlay directories that ikiwiki will
1035 search for files.
1037 If the directory name is not absolute, ikiwiki will assume it is in
1038 the parent directory of the configured underlaydir.
1040 ### `displaytime($;$$)`
1042 Given a time, formats it for display.
1044 The optional second parameter is a strftime format to use to format the
1045 time.
1047 If the third parameter is true, this is the publication time of a page.
1048 (Ie, set the html5 pubdate attribute.)
1050 ### `gettext`
1052 This is the standard gettext function, although slightly optimised.
1054 ### `ngettext`
1056 This is the standard ngettext function, although slightly optimised.
1058 ### `urlto($;$$)`
1060 Construct a relative url to the first parameter from the page named by the
1061 second. The first parameter can be either a page name, or some other
1062 destination file, as registered by `will_render`.
1064 Provide a second parameter whenever possible, since this leads to better
1065 behaviour for the [[plugins/po]] plugin and `file:///` URLs.
1067 If the second parameter is not specified (or `undef`), the URL will be
1068 valid from any page on the wiki, or from the CGI; if possible it'll
1069 be a path starting with `/`, but an absolute URL will be used if
1070 the wiki and the CGI are on different domains.
1072 If the third parameter is passed and is true, the url will be a fully
1073 absolute url. This is useful when generating an url to publish elsewhere.
1075 ### `newpagefile($$)`
1077 This can be called when creating a new page, to determine what filename
1078 to save the page to. It's passed a page name, and its type, and returns
1079 the name of the file to create, relative to the srcdir.
1081 ### `targetpage($$;$)`
1083 Passed a page and an extension, returns the filename that page will be
1084 rendered to.
1086 Optionally, a third parameter can be passed, to specify the preferred
1087 filename of the page. For example, `targetpage("foo", "rss", "feed")`
1088 will yield something like `foo/feed.rss`.
1090 ### `add_link($$;$)`
1092 This adds a link to `%links`, ensuring that duplicate links are not
1093 added. Pass it the page that contains the link, and the link text.
1095 An optional third parameter sets the link type. If not specified,
1096 it is an ordinary [[ikiwiki/WikiLink]].
1098 ### `add_autofile($$$)`
1100 Sometimes you may want to add a file to the `srcdir` as a result of content
1101 of other pages. For example, [[plugins/tag]] pages can be automatically
1102 created as needed. This function can be used to do that. 
1104 The three parameters are the filename to create (relative to the `srcdir`),
1105 the name of the plugin, and a callback function. The callback will be
1106 called if it is appropriate to automatically add the file, and should then
1107 take care of creating it, and doing anything else it needs to (such as
1108 checking it into revision control). Note that the callback may not always
1109 be called. For example, if an automatically added file is deleted by the
1110 user, ikiwiki will avoid re-adding it again.
1112 This function needs to be called during the scan hook, or earlier in the
1113 build process, in order to add the file early enough for it to be built.
1115 ## Miscellaneous
1117 ### Internal use pages
1119 Sometimes it's useful to put pages in the wiki without the overhead of
1120 having them be rendered to individual html files. Such internal use pages
1121 are collected together to form the RecentChanges page, for example.
1123 To make an internal use page, register a filename extension that starts
1124 with "_". Internal use pages cannot be edited with the web interface,
1125 generally shouldn't contain [[WikiLinks|ikiwiki/WikiLink]] or preprocessor directives (use
1126 either on them with extreme caution), and are not matched by regular
1127 PageSpecs glob patterns, but instead only by a special `internal()`
1128 [[ikiwiki/PageSpec]].
1130 ### RCS plugins
1132 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
1133 plugins. See [[RCS_details|rcs/details]] for some more info.
1135 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
1136 and the 'id' field is set to the name of the hook. For example:
1137         
1138         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
1139         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
1141 #### `rcs_update()`
1143 Updates the working directory with any remote changes.
1145 #### `rcs_prepedit($)`
1147 Is passed a file to prepare to edit. It can generate and return an arbitrary
1148 token, that will be passed into `rcs_commit` when committing. For example,
1149 it might return the current revision ID of the file, and use that
1150 information later when merging changes.
1152 #### `rcs_commit(@)`
1154 Passed named parameters: `file`, `message`, `token` (from `rcs_prepedit`),
1155 and `session` (optional).
1157 Should try to commit the file. Returns `undef` on *success* and a version
1158 of the page with the rcs's conflict markers on failure.
1160 #### `rcs_commit_staged(@)`
1162 Passed named parameters: `message`, and `session` (optional).
1164 Should commit all staged changes. Returns undef on success, and an
1165 error message on failure.
1167 Changes can be staged by calls to `rcs_add`, `rcs_remove`, and
1168 `rcs_rename`.
1170 #### `rcs_add($)`
1172 Adds the passed file to the archive. The filename is relative to the root
1173 of the srcdir.
1175 Note that this should not commit the new file, it should only
1176 prepare for it to be committed when rcs_commit (or `rcs_commit_staged`) is
1177 called. Note that the file may be in a new subdir that is not yet in
1178 to version control; the subdir can be added if so.
1180 #### `rcs_remove($)`
1182 Remove a file. The filename is relative to the root of the srcdir.
1184 Note that this should not commit the removal, it should only prepare for it
1185 to be committed when `rcs_commit` (or `rcs_commit_staged`) is called.
1187 #### `rcs_rename($$)`
1189 Rename a file. The filenames are relative to the root of the srcdir.
1191 Note that this should not commit the rename, it should only
1192 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
1193 The new filename may be in a new subdir, that is not yet added to
1194 version control. If so, the subdir will exist already, and should
1195 be added to revision control.
1197 #### `rcs_recentchanges($)`
1199 Examine the RCS history and generate a list of recent changes.
1200 The parameter is how many changes to return.
1202 The data structure returned for each change is:
1204         {
1205                 rev => # the RCSs id for this commit
1206                 user => # user who made the change (may be an openid),
1207                 nickname => # short name for user (optional; not an openid),
1208                 
1209                 committype => # either "web" or the name of the rcs,
1210                 when => # time when the change was made,
1211                 message => [
1212                         { line => "commit message line 1" },
1213                         { line => "commit message line 2" },
1214                         # etc,
1215                 ],
1216                 pages => [
1217                         {
1218                                 page => # name of page changed,
1219                                 diffurl => # optional url to a diff of changes
1220                         },
1221                         # repeat for each page changed in this commit,
1222                 ],
1223         }
1225 #### `rcs_diff($;$)`
1227 The first parameter is the rev from `rcs_recentchanges`.
1228 The optional second parameter is how many lines to return (default: all).
1230 Should return a list of lines of the diff (including \n) in list
1231 context, and a string containing the whole diff in scalar context.
1233 #### `rcs_getctime($)`
1235 This is used to get the page creation time for a file from the RCS, by looking
1236 it up in the history.
1238 If the RCS cannot determine a ctime for the file, return 0.
1240 #### `rcs_getmtime($)`
1242 This is used to get the page modification time for a file from the RCS, by
1243 looking it up in the history.
1245 It's ok if this is not implemented, and throws an error.
1247 If the RCS cannot determine a mtime for the file, return 0.
1249 #### `rcs_receive()`
1251 This is called when ikiwiki is running as a pre-receive hook (or
1252 equivalent), and is testing if changes pushed into the RCS from an
1253 untrusted user should be accepted. This is optional, and doesn't make
1254 sense to implement for all RCSs.
1256 It should examine the incoming changes, and do any sanity 
1257 checks that are appropriate for the RCS to limit changes to safe file adds,
1258 removes, and changes. If something bad is found, it should die, to abort
1259 the push. Otherwise, it should return a list of files that were changed,
1260 in the form:
1262         {
1263                 file => # name of file that was changed
1264                 action => # either "add", "change", or "remove"
1265                 path => # temp file containing the new file content, only
1266                         # needed for "add"/"change", and only if the file
1267                         # is an attachment, not a page
1268         }
1270 The list will then be checked to make sure that each change is one that
1271 is allowed to be made via the web interface.
1273 #### `rcs_preprevert($)`
1275 This is called by the revert web interface. It is passed a RCS-specific
1276 change ID, and should determine what the effects would be of reverting
1277 that change, and return the same data structure as `rcs_receive`.
1279 Like `rcs_receive`, it should do whatever sanity checks are appropriate
1280 for the RCS to limit changes to safe changes, and die if a change would
1281 be unsafe to revert.
1283 #### `rcs_revert($)`
1285 This is called by the revert web interface. It is passed a named
1286 parameter rev that is the RCS-specific change ID to revert.
1288 It should try to revert the specified rev, and leave the reversion staged
1289 so `rcs_commit_staged` will complete it. It should return undef on _success_
1290 and an error message on failure.
1292 This hook and `rcs_preprevert` are optional, if not implemented, no revert
1293 web interface will be available.
1295 ### `rcs_find_changes($)`
1297 Finds changes committed since the passed RCS-specific rev. Returns
1298 a hash of the files changed, a hash of the files deleted, and the
1299 current rev.
1301 This hook is optional.
1303 ### `rcs_get_current_rev()`
1305 Gets a RCS-specific rev, which can later be passed to `rcs_find_changes`.
1307 This hook is optional.
1309 ### PageSpec plugins
1311 It's also possible to write plugins that add new functions to
1312 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
1313 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
1314 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
1315 two parameters: The name of the page being matched, and the thing to match
1316 against. It may also be passed additional, named parameters.
1318 It should return a IkiWiki::SuccessReason object if the match succeeds, or
1319 an IkiWiki::FailReason object if the match fails. If the match cannot be
1320 attempted at all, for any page, it can instead return an
1321 IkiWiki::ErrorReason object explaining why.
1323 When constructing these objects, you should also include information about
1324 of any pages whose contents or other metadata influenced the result of the
1325 match. Do this by passing a list of pages, followed by `deptype` values.
1327 For example, "backlink(foo)" is influenced by the contents of page foo;
1328 "link(foo)" and "title(bar)" are influenced by the contents of any page
1329 they match; "created_before(foo)" is influenced by the metadata of foo;
1330 while "glob(*)" is not influenced by the contents of any page.
1332 ### Sorting plugins
1334 Similarly, it's possible to write plugins that add new functions as
1335 [[ikiwiki/pagespec/sorting]] methods. To achieve this, add a function to
1336 the IkiWiki::SortSpec package named `cmp_foo`, which will be used when sorting
1337 by `foo` or `foo(...)` is requested.
1339 The names of pages to be compared are in the global variables `$a` and `$b`
1340 in the IkiWiki::SortSpec package. The function should return the same thing
1341 as Perl's `cmp` and `<=>` operators: negative if `$a` is less than `$b`,
1342 positive if `$a` is greater, or zero if they are considered equal. It may
1343 also raise an error using `error`, for instance if it needs a parameter but
1344 one isn't provided.
1346 The function will also be passed one or more parameters. The first is
1347 `undef` if invoked as `foo`, or the parameter `"bar"` if invoked as `foo(bar)`;
1348 it may also be passed additional, named parameters.
1350 ### Setup plugins
1352 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
1353 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
1354 and the rest of the file is passed to that module's import method.
1356 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
1357 can be used to configure ikiwiki in different ways. These modules should,
1358 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
1359 to a hash containing all the config items. They should also implement a
1360 `gendump` function.
1362 By the way, to parse a ikiwiki setup file and populate `%config`, a
1363 program just needs to do something like:
1364 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`
1366 ### Function overriding
1368 Sometimes using ikiwiki's pre-defined hooks is not enough. Your plugin
1369 may need to replace one of ikiwiki's own functions with a modified version,
1370 or wrap one of the functions.
1372 For example, your plugin might want to override `displaytime`, to change
1373 the html markup used when displaying a date. Or it might want to override
1374 `IkiWiki::formattime`, to change how a date is formatted. Or perhaps you
1375 want to override `bestlink` and change how ikiwiki deals with [[WikiLinks|ikiwiki/WikiLink]].
1377 By venturing into this territory, your plugin is becoming tightly tied to
1378 ikiwiki's internals. And it might break if those internals change. But
1379 don't let that stop you, if you're brave.
1381 Ikiwiki provides an `inject()` function, that is a powerful way to replace
1382 any function with one of your own. This even allows you to inject a
1383 replacement for an exported function, like `bestlink`. Everything that
1384 imports that function will get your version instead. Pass it the name of
1385 the function to replace, and a new function to call. 
1387 For example, here's how to replace `displaytime` with a version using HTML 5
1388 markup:
1390         inject(name => 'IkiWiki::displaytime', call => sub {
1391                 return "<time>".formattime(@_)."</time>";
1392         });
1394 Here's how to wrap `bestlink` with a version that tries to handle
1395 plural words:
1397         my $origbestlink=\&bestlink;
1398         inject(name => 'IkiWiki::bestlink', call => \&mybestlink);
1400         sub deplural ($) {
1401                 my $word=shift;
1402                 $word =~ s/e?s$//; # just an example :-)
1403                 return $word;
1404         }
1406         sub mybestlink ($$) {
1407                 my $page=shift;
1408                 my $link=shift;
1409                 my $ret=$origbestlink->($page, $link);
1410                 if (! length $ret) {
1411                         $ret=$origbestlink->($page, deplural($link));
1412                 }
1413                 return $ret;
1414         }
1416 ### Javascript
1418 Some plugins use javascript to make ikiwiki look a bit more web-2.0-ish.
1420 All javascript code should be put in `.js` files in the `javascript`
1421 underlay, and plugins using those files can enable use of the underlay by
1422 calling `add_underlay("javascript");` in their `import` function.
1424 You'll have to arrange for `<script>` tags to be added to the pages that
1425 use your javascript. This can be done using a `format` hook.
1427 Ikiwiki provides some utility functions in `ikiwiki.js`, for use by other
1428 javascript code. These include:
1430 #### `getElementsByClass(cls, node, tag)` 
1432 Returns an array of elements with the given class. The node and tag are
1433 optional and define what document node and element names to search.
1435 #### `hook(name, call)`
1437 The function `call` will be run as part of the hook named `name`.
1439 Note that to hook into `window.onload`, you can use the `onload' hook.
1441 #### `run_hooks(name)`
1443 Runs the hooks with the specified name.