add readtemplate hook
[ikiwiki.git] / doc / plugins / write.mdwn
1 Ikiwiki's plugin interface allows all kinds of useful [[plugins]] to be
2 written to extend ikiwiki in many ways. Despite the length of this page,
3 it's not really hard. This page is a complete reference to everything a
4 plugin might want to do. There is also a quick [[tutorial]].
5
6 [[!template id="note" text="""
7 Ikiwiki is a compiler
8
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.
13
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.
18
19 The [[tutorial]] has some other examples of ways that ikiwiki being a
20 compiler may trip up the unwary.
21 """]]
22
23 [[!toc levels=2]]
24
25 ## Highlevel view of ikiwiki
26
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.
31
32 ### compiler
33
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.
39
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]].
49
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.
54
55 ### cgi
56
57 The flow between hooks when ikiwiki is run as a cgi is best illustrated by
58 an example.
59
60 Alice browses to a page and clicks Edit.
61
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.
73
74 Alice signs in with her openid.
75
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.
87
88 Alice saves her change to the page.
89
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.
95
96 ## Types of plugins
97
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.
102
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`.
111
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]].
116
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.
121
122 ## Plugin interface
123
124 To import the ikiwiki plugin interface:
125
126         use IkiWiki '3.00';
127
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.
132
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.
136
137 ## Registering plugins
138
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.
143
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.
148
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.
152
153 ## Types of hooks
154
155 In roughly the order they are called.
156
157 ### getopt
158
159         hook(type => "getopt", id => "foo", call => \&getopt);
160
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`.
169
170 ### checkconfig
171
172         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
173
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.
179
180 ### <a name="refresh">refresh</a>
181
182         hook(type => "refresh", id => "foo", call => \&refresh);
183
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.
187
188 ### <a name="needsbuild">needsbuild</a>
189
190         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
191
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. 
194
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.
198
199 The second parameter passed to the function is a reference to an array of
200 files that have been deleted.
201
202 ### <a name="scan">scan</a>
203
204         hook(type => "scan", id => "foo", call => \&scan);
205
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.
210
211 The function is passed named parameters "page" and "content". Its return
212 value is ignored.
213
214 ### <a name="readtemplate">readtemplate</a>
215
216         hook(type => "readtemplate", id => "foo", call => \&readtemplate);
217
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
221 The function is passed named parameters:
222
223 * `id`: the name under which the template was looked up,
224   such as `page.tmpl` or `note`
225 * `page`: the name of the template as a page or attachment in the wiki,
226   such as `templates/note`, or `undef` if it's outside the wiki (e.g. in
227   `/usr/share/ikiwiki/templates`)
228 * `content`: the content of the corresponding file
229 * `untrusted`: true if the template was loaded from the wiki or an underlay,
230   false if it was loaded from a trusted location
231
232 It should return the replacement content.
233
234 ### <a name="filter">filter</a>
235
236         hook(type => "filter", id => "foo", call => \&filter);
237
238 Runs on the full raw source of a page, before anything else touches it, and
239 can make arbitrary changes. The function is passed named parameters "page",
240 "destpage", and "content". It should return the filtered content.
241
242 ### <a name="preprocess">preprocess</a>
243
244 Adding a preprocessor [[ikiwiki/directive]] is probably the most common use
245 of a plugin.
246
247         hook(type => "preprocess", id => "foo", call => \&preprocess);
248
249 Replace "foo" with the command name that will be used for the preprocessor
250 directive.
251
252 Each time the directive is processed, the referenced function (`preprocess`
253 in the example above) is called. Whatever the function returns goes onto
254 the page in place of the directive. Or, if the function aborts using
255 `error()`, the directive will be replaced with the error message.
256
257 The function is passed named parameters. First come the parameters set
258 in the preprocessor directive. These are passed in the same order as
259 they're in the directive, and if the preprocessor directive contains a bare
260 parameter (example: `\[[!foo param]]`), that parameter will be passed with
261 an empty value.
262
263 After the parameters from the preprocessor directive some additional ones
264 are passed: A "page" parameter gives the name of the page that embedded the
265 preprocessor directive, while a "destpage" parameter gives the name of the
266 page the content is going to (different for inlined pages), and a "preview"
267 parameter is set to a true value if the page is being previewed.
268
269 If `hook` is passed an optional "scan" parameter, set to a true value, this
270 makes the hook be called during the preliminary scan that ikiwiki makes of
271 updated pages, before begining to render pages. This should be done if the
272 hook modifies data in `%links` (typically by calling `add_link`). Note that
273 doing so will make the hook be run twice per page build, so avoid doing it
274 for expensive hooks. (As an optimisation, if your preprocessor hook is
275 called in a void context, you can assume it's being run in scan mode, and
276 avoid doing expensive things at that point.)
277
278 Note that if the [[htmlscrubber]] is enabled, html in
279 preprocessor [[ikiwiki/directive]] output is sanitised, which may limit what
280 your plugin can do. Also, the rest of the page content is not in html
281 format at preprocessor time. Text output by a preprocessor directive will
282 be linkified and passed through markdown (or whatever engine is used to
283 htmlize the page) along with the rest of the page.
284
285 ### <a name="linkify">linkify</a>
286
287         hook(type => "linkify", id => "foo", call => \&linkify);
288
289 This hook is called to convert [[WikiLinks|ikiwiki/WikiLink]] on the page into html
290 links. The function is passed named parameters "page", "destpage", and
291 "content". It should return the linkified content.  Present in IkiWiki 2.40
292 and later.
293
294 Plugins that implement linkify must also implement a scan hook, that scans
295 for the links on the page and adds them to `%links` (typically by calling
296 `add_link`).
297
298 ### <a name="htmlize">htmlize</a>
299
300         hook(type => "htmlize", id => "ext", call => \&htmlize);
301
302 Runs on the source of a page and turns it into html. The id parameter
303 specifies the filename extension that a file must have to be htmlized using
304 this plugin. This is how you can add support for new and exciting markup
305 languages to ikiwiki.
306
307 The function is passed named parameters: "page" and "content" and should
308 return the htmlized content.
309
310 If `hook` is passed an optional "keepextension" parameter, set to a true
311 value, then the extension will not be stripped from the source filename when
312 generating the page.
313
314 If `hook` is passed an optional "noextension" parameter, set to a true
315 value, then the id parameter specifies not a filename extension, but
316 a whole filename that can be htmlized. This is useful for files
317 like `Makefile` that have no extension.
318
319 If `hook` is passed an optional "longname" parameter, this value is used
320 when prompting a user to choose a page type on the edit page form.
321
322 ### <a name="indexhtml">indexhtml</a>
323
324         hook(type => "indexhtml", id => "foo", call => \&indexhtml);
325
326 This hook is called once the page has been converted to html (but before
327 the generated html is put in a template). The most common use is to
328 update search indexes. Added in ikiwiki 2.54.
329
330 The function is passed named parameters "page", "destpage", and "content".
331 Its return value is ignored.
332
333 ### <a name="pagetemplate">pagetemplate</a>
334
335         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
336
337 [[Templates]] are filled out for many different things in
338 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
339 a cgi. This hook allows modifying the variables available on those
340 templates. The function is passed named parameters. The "page" and
341 "destpage" parameters are the same as for a preprocess hook. The "template"
342 parameter is a [[!cpan HTML::Template]] object that is the template that
343 will be used to generate the page. The function can manipulate that
344 template object.
345
346 The most common thing to do is probably to call `$template->param()` to add
347 a new custom parameter to the template.
348
349 ### templatefile
350
351         hook(type => "templatefile", id => "foo", call => \&templatefile);
352
353 This hook allows plugins to change the [[template|templates]] that is
354 used for a page in the wiki. The hook is passed a "page" parameter, and
355 should return the name of the template file to use (relative to the
356 template directory), or undef if it doesn't want to change the default
357 ("page.tmpl").
358
359 ### pageactions
360
361         hook(type => "pageactions", id => "foo", call => \&pageactions);
362
363 This hook allows plugins to add arbitrary actions to the action bar on a
364 page (next to Edit, RecentChanges, etc). The hook is passed a "page"
365 parameter, and can return a list of html fragments to add to the action
366 bar.
367
368 ### <a name="sanitize">sanitize</a>
369
370         hook(type => "sanitize", id => "foo", call => \&sanitize);
371
372 Use this to implement html sanitization or anything else that needs to
373 modify the body of a page after it has been fully converted to html.
374
375 The function is passed named parameters: "page", "destpage", and "content",
376 and should return the sanitized content.
377
378 ### <a name="format">format</a>
379
380         hook(type => "format", id => "foo", call => \&format);
381
382 The difference between format and sanitize is that sanitize only acts on
383 the page body, while format can modify the entire html page including the
384 header and footer inserted by ikiwiki, the html document type, etc. (It
385 should not rely on always being passed the entire page, as it won't be
386 when the page is being previewed.)
387
388 The function is passed named parameters: "page" and "content", and 
389 should return the formatted content.
390
391 ### build_affected
392
393         hook(type => "build_affected", id => "foo", call => \&build_affected);
394
395 This hook is called after the directly changed pages have been built,
396 and can cause extra pages to be built. If links and backlinks were provided
397 by a plugin, this would be where that plugin would rebuild pages whose
398 backlinks have changed, for instance. The [[trail]] plugin uses this hook
399 to rebuild pages whose next or previous page has changed.
400
401 The function should currently ignore its parameters. It returns a list with
402 an even number of items (a hash in list context), where the first item of
403 each pair is a page name to be rebuilt (if it was not already rebuilt), and
404 the second is a log message resembling
405 `building plugins/write because the phase of the moon has changed`.
406
407 ### <a name="delete">delete</a>
408
409         hook(type => "delete", id => "foo", call => \&delete);
410
411 After a page or pages is removed from the wiki, the referenced function
412 is called, and passed the names of the source files that were removed.
413
414 ### rendered
415
416         hook(type => "rendered", id => "foo", call => \&rendered);
417
418 After ikiwiki renders a change or addition (but not deletion) to the
419 wiki, the referenced function is called, and passed the names of the
420 source files that were rendered.
421
422 (This hook used to be called "change", but that was not accurate.
423 For now, plugins using the old hook name will still work.)
424
425 ### <a name="changes">changes</a>
426
427         hook(type => "changes", id => "foo", call => \&changes);
428
429 After ikiwiki renders changes to the wiki, the referenced function is
430 called, and passed the names of the source files that were added, modified,
431 or deleted.
432
433 ### cgi
434
435         hook(type => "cgi", id => "foo", call => \&cgi);
436
437 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
438 called in turn, and passed a CGI object. The hook should examine the
439 parameters, and if it will handle this CGI request, output a page
440 (including the http headers) and terminate the program.
441
442 Note that cgi hooks are called as early as possible, before any ikiwiki
443 state is loaded, and with no session information.
444
445 ### <a name="auth">auth</a>
446
447         hook(type => "auth", id => "foo", call => \&auth);
448
449 This hook can be used to implement an authentication method. When a user
450 needs to be authenticated, each registered auth hook is called in turn, and
451 passed a CGI object and a session object. 
452
453 If the hook is able to authenticate the user, it should set the session
454 object's "name" parameter to the authenticated user's name. Note that
455 if the name is set to the name of a user who is not registered,
456 a basic registration of the user will be automatically performed.
457
458 ### <a name="sessioncgi">sessioncgi</a>
459
460         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
461
462 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
463 is only run once a session object is available. It is passed both a CGI
464 object and a session object. To check if the user is in fact signed in, you
465 can check if the session object has a "name" parameter set.
466
467 ### <a name="canedit">canedit</a>
468
469         hook(type => "canedit", id => "foo", call => \&canedit);
470
471 This hook can be used to implement arbitrary access methods to control when
472 a page can be edited using the web interface (commits from revision control
473 bypass it). When a page is edited, each registered canedit hook is called
474 in turn, and passed the page name, a CGI object, and a session object.
475
476 If the hook has no opinion about whether the edit can proceed, return
477 `undef`, and the next plugin will be asked to decide. If edit can proceed,
478 the hook should return "". If the edit is not allowed by this hook, the
479 hook should return an error message for the user to see, or a function 
480 that can be run to log the user in or perform other action necessary for
481 them to be able to edit the page.
482
483 This hook should avoid directly redirecting the user to a signin page,
484 since it's sometimes used to test to see which pages in a set of pages a
485 user can edit.
486
487 ### canremove
488
489         hook(type => "canremove", id => "foo", call => \&canremove);
490
491 This hook can be used to implement arbitrary access methods to control
492 when a page can be removed using the web interface (commits from
493 revision control bypass it). It works exactly like the `canedit` hook,
494 but is passed the named parameters `cgi` (a CGI object), `session`
495 (a session object) and `page` (the page subject to deletion).
496
497 ### canrename
498
499         hook(type => "canrename", id => "foo", call => \&canrename);
500
501 This hook can be used to implement arbitrary access methods to control when
502 a page can be renamed using the web interface (commits from revision control
503 bypass it). It works exactly like the `canedit` hook,
504 but is passed the named parameters `cgi` (a CGI object), `session` (a
505 session object), `src`, `srcfile`, `dest` and `destfile`.
506
507 ### <a name="checkcontent">checkcontent</a>
508         
509         hook(type => "checkcontent", id => "foo", call => \&checkcontent);
510
511 This hook is called to check the content a user has entered on a page,
512 before it is saved, and decide if it should be allowed.
513
514 It is passed named parameters: `content`, `page`, `cgi`, and `session`. If
515 the content the user has entered is a comment, it may also be passed some
516 additional parameters: `author`, `url`, and `subject`. The `subject`
517 parameter may also be filled with the user's comment about the change.
518
519 Note: When the user edits an existing wiki page, this hook is also
520 passed a `diff` named parameter, which will include only the lines
521 that they added to the page, or modified.
522
523 The hook should return `undef` on success. If the content is disallowed, it
524 should return a message stating what the problem is, or a function
525 that can be run to perform whatever action is necessary to allow the user
526 to post the content.
527
528 ### <a name="editcontent">editcontent</a>
529
530         hook(type => "editcontent", id => "foo", call => \&editcontent);
531
532 This hook is called when a page is saved (or previewed) using the web
533 interface. It is passed named parameters: `content`, `page`, `cgi`, and
534 `session`. These are, respectively, the new page content as entered by the
535 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
536
537 It can modify the content as desired, and should return the content.
538
539 ### <a name="formbuilder">formbuilder</a>
540
541         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
542         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
543
544 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
545 CGI::FormBuilder]] to generate web forms. These hooks are passed named
546 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
547 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
548 reference to an array of names of buttons to go on the form.
549
550 Each time a form is set up, the `formbuilder_setup` hook is called.
551 Typically the `formbuilder_setup` hook will check the form's title, and if
552 it's a form that it needs to modify, will call various methods to
553 add/remove/change fields, tweak the validation code for the fields, etc. It
554 will not validate or display the form.
555
556 Just before a form is displayed to the user, the `formbuilder` hook is
557 called. It can be used to validate the form, but should not display it.
558
559 ### savestate
560
561         hook(type => "savestate", id => "foo", call => \&savestate);
562
563 This hook is called whenever ikiwiki normally saves its state, just before
564 the state is saved. The function can save other state, modify values before
565 they're saved, etc.
566
567 ### renamepage
568
569         hook(type => "renamepage", id => "foo", call => \&renamepage);
570
571 This hook is called by the [[plugins/rename]] plugin when it renames
572 something, once per page linking to the renamed page's old location.
573 The hook is passed named parameters: `page`, `oldpage`, `newpage`, and
574 `content`, and should try to modify the content of `page` to reflect
575 the name change. For example, by converting links to point to the
576 new page.
577
578 ### rename
579
580         hook(type => "rename", id => "foo", call => \&rename);
581
582 When a page or set of pages is renamed, the referenced function is
583 called for every page, and is passed named parameters:
584
585 * `torename`: a reference to a hash with keys: `src`, `srcfile`,
586   `dest`, `destfile`, `required`.
587 * `cgi`: a CGI object
588 * `session`: a session object.
589
590 Such a hook function returns any additional rename hashes it wants to
591 add. This hook is applied recursively to returned additional rename
592 hashes, so that it handles the case where two plugins use the hook:
593 plugin A would see when plugin B adds a new file to be renamed.
594
595 ### getsetup
596
597         hook(type => "getsetup", id => "foo", call => \&getsetup);
598
599 This hooks is not called during normal operation, but only when setting up 
600 the wiki, or generating a setup file. Plugins can use this hook to add
601 configuration options.
602
603 The hook is passed no parameters. It returns data about the configuration
604 options added by the plugin. It can also check if the plugin is usable, and
605 die if not, which will cause the plugin to not be offered in the configuration
606 interface.
607
608 The data returned is a list of `%config` options, followed by a hash
609 describing the option. There can also be an item named "plugin", which
610 describes the plugin as a whole. For example:
611
612                 return
613                         plugin => {
614                                 description => "description of this plugin",
615                                 safe => 1,
616                                 rebuild => 1,
617                                 section => "misc",
618                         },
619                         option_foo => {
620                                 type => "boolean",
621                                 description => "enable foo?",
622                                 advanced => 1,
623                                 safe => 1,
624                                 rebuild => 1,
625                         },
626                         option_bar => {
627                                 type => "string",
628                                 example => "hello",
629                                 description => "option bar",
630                                 safe => 1,
631                                 rebuild => 0,
632                         },
633
634 * `type` can be "boolean", "string", "integer", "pagespec",
635   or "internal" (used for values that are not user-visible). The type is
636   the type of the leaf values;  the `%config` option may be an array or
637   hash of these.
638 * `example` can be set to an example value.
639 * `description` is a short description of the option.
640 * `link` is a link to further information about the option. This can either
641   be a [[ikiwiki/WikiLink]], or an url.
642 * `htmldescription` is displayed instead of the description by websetup.
643 * `advanced` can be set to true if the option is more suitable for advanced
644   users.
645 * `safe` should be false if the option should not be displayed in unsafe
646   configuration methods, such as the web interface. Anything that specifies
647   a command to run, a path on disk, or a regexp should be marked as unsafe.
648   If a plugin is marked as unsafe, that prevents it from being
649   enabled/disabled.
650 * `rebuild` should be true if changing the option (or enabling/disabling
651   the plugin) will require a wiki rebuild, false if no rebuild is needed,
652   and undef if a rebuild could be needed in some circumstances, but is not
653   strictly required.
654 * `section` can optionally specify which section in the config file
655   the plugin fits in. The convention is to name the sections the
656   same as the tags used for [[plugins]] on this wiki.
657
658 ### genwrapper
659
660         hook(type => "genwrapper", id => "foo", call => \&genwrapper);
661
662 This hook is used to inject C code (which it returns) into the `main`
663 function of the ikiwiki wrapper when it is being generated. 
664
665 The code runs before anything else -- in particular it runs before
666 the suid wrapper has sanitized its environment.
667
668 ### disable
669
670         hook(type => "disable", id => "foo", call => \&disable);
671
672 This hook is only run when a previously enabled plugin gets disabled
673 during ikiwiki setup. Plugins can use this to perform cleanups.
674
675 ## Exported variables
676
677 Several variables are exported to your plugin when you `use IkiWiki;`
678
679 ### `%config`
680
681 A plugin can access the wiki's configuration via the `%config`
682 hash. The best way to understand the contents of the hash is to look at
683 your ikiwiki setup file, which sets the hash content to configure the wiki.
684
685 ### `%pagestate`
686
687 The `%pagestate` hash can be used by plugins to save state that they will need
688 next time ikiwiki is run. The hash holds per-page state, so to set a value,
689 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
690 use `$pagestate{$page}{$id}{$key}`.
691
692 The `$value` can be anything that perl's Storable module is capable of
693 serializing. `$key` can be any string you like, but `$id` must be the same
694 as the "id" parameter passed to `hook()` when registering the plugin. This
695 is so ikiwiki can know when to delete pagestate for plugins that are no
696 longer used.
697
698 When pages are deleted, ikiwiki automatically deletes their pagestate too.
699
700 Note that page state does not persist across wiki rebuilds, only across
701 wiki updates.
702
703 ### `%wikistate`
704
705 The `%wikistate` hash can be used by a plugin to store persistant state
706 that is not bound to any one page. To set a value, use
707 `$wikistate{$id}{$key}=$value`, where `$value` is anything Storable can
708 serialize, `$key` is any string you like, and `$id` must be the same as the
709 "id" parameter passed to `hook()` when registering the plugin, so that the
710 state can be dropped if the plugin is no longer used.
711
712 ### `%links`
713
714 The `%links` hash can be used to look up the names of each page that
715 a page links to. The name of the page is the key; the value is an array
716 reference. Do not modify this hash directly; call `add_link()`.
717
718         $links{"foo"} = ["bar", "baz"];
719
720 ### `%typedlinks`
721
722 The `%typedlinks` hash records links of specific types. Do not modify this
723 hash directly; call `add_link()`. The keys are page names, and the values
724 are hash references. In each page's hash reference, the keys are link types
725 defined by plugins, and the values are hash references with link targets
726 as keys, and 1 as a dummy value, something like this:
727
728         $typedlinks{"foo"} = {
729                 tag => { short_word => 1, metasyntactic_variable => 1 },
730                 next_page => { bar => 1 },
731         };
732
733 Ordinary [[WikiLinks|ikiwiki/WikiLink]] appear in `%links`, but not in
734 `%typedlinks`.
735
736 ### `%pagesources`
737
738 The `%pagesources` has can be used to look up the source filename
739 of a page. So the key is the page name, and the value is the source
740 filename. Do not modify this hash.
741
742         $pagesources{"foo"} = "foo.mdwn";
743
744 ### `%destsources`
745
746 The `%destsources` hash records the name of the source file used to
747 create each destination file. The key is the output filename (ie,
748 "foo/index.html"), and the value is the source filename that it was built
749 from (eg, "foo.mdwn"). Note that a single source file may create multiple
750 destination files. Do not modify this hash directly; call `will_render()`.
751         
752         $destsources{"foo/index.html"} = "foo.mdwn";
753
754 ## Library functions
755
756 Several functions are exported to your plugin when you `use IkiWiki;`
757
758 ### `hook(@)`
759
760 Hook into ikiwiki's processing. See the discussion of hooks above.
761
762 Note that in addition to the named parameters described above, a parameter
763 named `no_override` is supported, If it's set to a true value, then this hook
764 will not override any existing hook with the same id. This is useful if
765 the id can be controled by the user.
766
767 ### `debug($)`
768
769 Logs a debugging message. These are supressed unless verbose mode is turned
770 on.
771
772 ### `error($;$)`
773
774 Aborts with an error message. If the second parameter is passed, it is a
775 function that is called after the error message is printed, to do any final
776 cleanup.
777
778 If called inside a preprocess hook, error() does not abort the entire
779 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
780 a version containing the error message.
781
782 In other hooks, error() is a fatal error, so use with care. Try to avoid
783 dying on bad input when building a page, as that will halt
784 the entire wiki build and make the wiki unusable.
785
786 ### `template($;@)`
787
788 Creates and returns a [[!cpan HTML::Template]] object. (In a list context,
789 returns the parameters needed to construct the obhect.) 
790
791 The first parameter is the name of the template file. The optional remaining
792 parameters are passed to `HTML::Template->new`.
793
794 Normally, the template file is first looked for in the templates/ subdirectory
795 of the srcdir. Failing that, it is looked for in the templatedir.
796
797 Wiki pages can be used as templates. This should be done only for templates
798 which it is safe to let wiki users edit. Enable it by passing a filename
799 with no ".tmpl" extension. Template pages are normally looked for in
800 the templates/ directory. If the page name starts with "/", a page
801 elsewhere in the wiki can be used.
802
803 If the template is not found, or contains a syntax error, an error is thrown.
804
805 ### `template_depends($$;@)`
806
807 Use this instead of `template()` if the content of a template is being
808 included into a page. This causes the page to depend on the template,
809 so it will be updated if the template is modified.
810
811 Like `template()`, except the second parameter is the page.
812
813 ### `htmlpage($)`
814
815 Passed a page name, returns the base name that will be used for a the html
816 page created from it. (Ie, it appends ".html".)
817
818 Use this when constructing the filename of a html file. Use `urlto` when
819 generating a link to a page.
820
821 ### `pagespec_match_list($$;@)`
822
823 Passed a page name, and [[ikiwiki/PageSpec]], returns a list of pages
824 in the wiki that match the [[ikiwiki/PageSpec]]. 
825
826 The page will automatically be made to depend on the specified
827 [[ikiwiki/PageSpec]], so `add_depends` does not need to be called. This
828 is often significantly more efficient than calling `add_depends` and
829 `pagespec_match` in a loop. You should use this anytime a plugin
830 needs to match a set of pages and do something based on that list.
831
832 Unlike pagespec_match, this may throw an error if there is an error in
833 the pagespec.
834
835 Additional named parameters can be specified:
836
837 * `deptype` optionally specifies the type of dependency to add. Use the
838   `deptype` function to generate a dependency type.
839 * `filter` is a reference to a function, that is called and passed a page,
840   and returns true if the page should be filtered out of the list.
841 * `sort` specifies a sort order for the list. See
842   [[ikiwiki/PageSpec/sorting]] for the avilable sort methods. Note that
843   if a sort method is specified that depends on the
844   page content (such as 'meta(foo)'), the deptype needs to be set to
845   a content dependency.
846 * `reverse` if true, sorts in reverse.
847 * `num` if nonzero, specifies the maximum number of matching pages that
848   will be returned.
849 * `list` makes it only match amoung the specified list of pages.
850   Default is to match amoung all pages in the wiki.
851
852 Any other named parameters are passed on to `pagespec_match`, to further
853 limit the match.
854
855 ### `add_depends($$;$)`
856
857 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
858
859 By default, dependencies are full content dependencies, meaning that the
860 page will be updated whenever anything matching the PageSpec is modified.
861 This can be overridden by passing a `deptype` value as the third parameter.
862
863 ### `pagespec_match($$;@)`
864
865 Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
866 [[ikiwiki/PageSpec]] matches the page.
867
868 Note that the return value is overloaded. If stringified, it will be a
869 message indicating why the PageSpec succeeded, or failed, to match the
870 page.
871
872 Additional named parameters can be passed, to further limit the match.
873 The most often used is "location", which specifies the location the
874 PageSpec should match against. If not passed, relative PageSpecs will match
875 relative to the top of the wiki.
876
877 ### `deptype(@)`
878
879 Use this function to generate ikiwiki's internal representation of a
880 dependency type from one or more of these keywords:
881
882 * `content` is the default. Any change to the content
883   of a page triggers the dependency.
884 * `presence` is only triggered by a change to the presence
885   of a page.
886 * `links` is only triggered by a change to the links of a page.
887   This includes when a link is added, removed, or changes what
888   it points to due to other changes. It does not include the
889   addition or removal of a duplicate link.
890
891 If multiple types are specified, they are combined.
892
893 ### `bestlink($$)`
894
895 Given a page and the text of a link on the page, determine which
896 existing page that link best points to. Prefers pages under a
897 subdirectory with the same name as the source page, failing that
898 goes down the directory tree to the base looking for matching
899 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
900
901 ### `htmllink($$$;@)`
902
903 Many plugins need to generate html links and add them to a page. This is
904 done by using the `htmllink` function. The usual way to call
905 `htmllink` is:
906
907         htmllink($page, $page, $link)
908
909 Why is `$page` repeated? Because if a page is inlined inside another, and a
910 link is placed on it, the right way to make that link is actually:
911
912         htmllink($page, $destpage, $link)
913
914 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
915 some of the hook functions above; the ones that are not passed it are not used
916 during inlining and don't need to worry about this issue.
917
918 After the three required parameters, named parameters can be used to
919 control some options. These are:
920
921 * noimageinline - set to true to avoid turning links into inline html images
922 * forcesubpage  - set to force a link to a subpage
923 * linktext - set to force the link text to something
924 * anchor - set to make the link include an anchor
925 * rel - set to add a rel attribute to the link
926 * class - set to add a css class to the link
927 * title - set to add a title attribute to the link
928
929 ### `readfile($;$)`
930
931 Given a filename, reads and returns the entire file.
932
933 The optional second parameter, if set to a true value, makes the file be read
934 in binary mode.
935
936 A failure to read the file will result in it dying with an error.
937
938 ### `writefile($$$;$$)`
939
940 Given a filename, a directory to put it in, and the file's content,
941 writes a file. 
942
943 The optional fourth parameter, if set to a true value, makes the file be
944 written in binary mode.
945
946 The optional fifth parameter can be used to pass a function reference that
947 will be called to handle writing to the file. The function will be called
948 and passed a file descriptor it should write to, and an error recovery
949 function it should call if the writing fails. (You will not normally need to
950 use this interface.)
951
952 A failure to write the file will result in it dying with an error.
953
954 If the destination directory doesn't exist, it will first be created.
955
956 The filename and directory are separate parameters because of
957 some security checks done to avoid symlink attacks. Before writing a file,
958 it checks to make sure there's not a symlink with its name, to avoid
959 following the symlink. If the filename parameter includes a subdirectory
960 to put the file in, it also checks if that subdirectory is a symlink, etc.
961 The directory parameter, however, is not checked for symlinks. So,
962 generally the directory parameter is a trusted toplevel directory like
963 the srcdir or destdir, and any subdirectories of this are included in the
964 filename parameter.
965
966 ### `will_render($$)`
967
968 Given a page name and a destination file name (not including the base
969 destination directory), register that the page will result in that file
970 being rendered. 
971
972 It's important to call this before writing to any file in the destination
973 directory, and it's important to call it consistently every time, even if
974 the file isn't really written this time -- unless you delete any old
975 version of the file. In particular, in preview mode, this should still be
976 called even if the file isn't going to be written to during the preview.
977
978 Ikiwiki uses this information to automatically clean up rendered files when
979 the page that rendered them goes away or is changed to no longer render
980 them. will_render also does a few important security checks.
981
982 ### `pagetype($)`
983
984 Given the name of a source file, returns the type of page it is, if it's
985 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
986
987 ### `pagename($)`
988
989 Given the name of a source file, returns the name of the wiki page
990 that corresponds to that file.
991
992 ### `pagetitle($)`
993
994 Give the name of a wiki page, returns a version suitable to be displayed as
995 the page's title. This is accomplished by de-escaping escaped characters in
996 the page name. "_" is replaced with a space, and '__NN__' is replaced by 
997 the UTF character with code NN.
998
999 ### `titlepage($)`
1000
1001 This performs the inverse of `pagetitle`, ie, it converts a page title into
1002 a wiki page name.
1003
1004 ### `linkpage($)`
1005
1006 This converts text that could have been entered by the user as a
1007 [[ikiwiki/WikiLink]] into a wiki page name.
1008
1009 ### `srcfile($;$)`
1010
1011 Given the name of a source file in the wiki, searches for the file in
1012 the source directory and the underlay directories (most recently added
1013 underlays first), and returns the full path to the first file found.
1014
1015 Normally srcfile will fail with an error message if the source file cannot
1016 be found. The second parameter can be set to a true value to make it return
1017 undef instead.
1018
1019 ### `add_underlay($)`
1020
1021 Adds a directory to the set of underlay directories that ikiwiki will
1022 search for files.
1023
1024 If the directory name is not absolute, ikiwiki will assume it is in
1025 the parent directory of the configured underlaydir.
1026
1027 ### `displaytime($;$$)`
1028
1029 Given a time, formats it for display.
1030
1031 The optional second parameter is a strftime format to use to format the
1032 time.
1033
1034 If the third parameter is true, this is the publication time of a page.
1035 (Ie, set the html5 pubdate attribute.)
1036
1037 ### `gettext`
1038
1039 This is the standard gettext function, although slightly optimised.
1040
1041 ### `ngettext`
1042
1043 This is the standard ngettext function, although slightly optimised.
1044
1045 ### `urlto($;$$)`
1046
1047 Construct a relative url to the first parameter from the page named by the
1048 second. The first parameter can be either a page name, or some other
1049 destination file, as registered by `will_render`.
1050
1051 Provide a second parameter whenever possible, since this leads to better
1052 behaviour for the [[plugins/po]] plugin and `file:///` URLs.
1053
1054 If the second parameter is not specified (or `undef`), the URL will be
1055 valid from any page on the wiki, or from the CGI; if possible it'll
1056 be a path starting with `/`, but an absolute URL will be used if
1057 the wiki and the CGI are on different domains.
1058
1059 If the third parameter is passed and is true, the url will be a fully
1060 absolute url. This is useful when generating an url to publish elsewhere.
1061
1062 ### `newpagefile($$)`
1063
1064 This can be called when creating a new page, to determine what filename
1065 to save the page to. It's passed a page name, and its type, and returns
1066 the name of the file to create, relative to the srcdir.
1067
1068 ### `targetpage($$;$)`
1069
1070 Passed a page and an extension, returns the filename that page will be
1071 rendered to.
1072
1073 Optionally, a third parameter can be passed, to specify the preferred
1074 filename of the page. For example, `targetpage("foo", "rss", "feed")`
1075 will yield something like `foo/feed.rss`.
1076
1077 ### `add_link($$;$)`
1078
1079 This adds a link to `%links`, ensuring that duplicate links are not
1080 added. Pass it the page that contains the link, and the link text.
1081
1082 An optional third parameter sets the link type. If not specified,
1083 it is an ordinary [[ikiwiki/WikiLink]].
1084
1085 ### `add_autofile($$$)`
1086
1087 Sometimes you may want to add a file to the `srcdir` as a result of content
1088 of other pages. For example, [[plugins/tag]] pages can be automatically
1089 created as needed. This function can be used to do that. 
1090
1091 The three parameters are the filename to create (relative to the `srcdir`),
1092 the name of the plugin, and a callback function. The callback will be
1093 called if it is appropriate to automatically add the file, and should then
1094 take care of creating it, and doing anything else it needs to (such as
1095 checking it into revision control). Note that the callback may not always
1096 be called. For example, if an automatically added file is deleted by the
1097 user, ikiwiki will avoid re-adding it again.
1098
1099 This function needs to be called during the scan hook, or earlier in the
1100 build process, in order to add the file early enough for it to be built.
1101
1102 ## Miscellaneous
1103
1104 ### Internal use pages
1105
1106 Sometimes it's useful to put pages in the wiki without the overhead of
1107 having them be rendered to individual html files. Such internal use pages
1108 are collected together to form the RecentChanges page, for example.
1109
1110 To make an internal use page, register a filename extension that starts
1111 with "_". Internal use pages cannot be edited with the web interface,
1112 generally shouldn't contain [[WikiLinks|ikiwiki/WikiLink]] or preprocessor directives (use
1113 either on them with extreme caution), and are not matched by regular
1114 PageSpecs glob patterns, but instead only by a special `internal()`
1115 [[ikiwiki/PageSpec]].
1116
1117 ### RCS plugins
1118
1119 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
1120 plugins. See [[RCS_details|rcs/details]] for some more info.
1121
1122 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
1123 and the 'id' field is set to the name of the hook. For example:
1124         
1125         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
1126         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
1127
1128 #### `rcs_update()`
1129
1130 Updates the working directory with any remote changes.
1131
1132 #### `rcs_prepedit($)`
1133
1134 Is passed a file to prepare to edit. It can generate and return an arbitrary
1135 token, that will be passed into `rcs_commit` when committing. For example,
1136 it might return the current revision ID of the file, and use that
1137 information later when merging changes.
1138
1139 #### `rcs_commit(@)`
1140
1141 Passed named parameters: `file`, `message`, `token` (from `rcs_prepedit`),
1142 and `session` (optional).
1143
1144 Should try to commit the file. Returns `undef` on *success* and a version
1145 of the page with the rcs's conflict markers on failure.
1146
1147 #### `rcs_commit_staged(@)`
1148
1149 Passed named parameters: `message`, and `session` (optional).
1150
1151 Should commit all staged changes. Returns undef on success, and an
1152 error message on failure.
1153
1154 Changes can be staged by calls to `rcs_add`, `rcs_remove`, and
1155 `rcs_rename`.
1156
1157 #### `rcs_add($)`
1158
1159 Adds the passed file to the archive. The filename is relative to the root
1160 of the srcdir.
1161
1162 Note that this should not commit the new file, it should only
1163 prepare for it to be committed when rcs_commit (or `rcs_commit_staged`) is
1164 called. Note that the file may be in a new subdir that is not yet in
1165 to version control; the subdir can be added if so.
1166
1167 #### `rcs_remove($)`
1168
1169 Remove a file. The filename is relative to the root of the srcdir.
1170
1171 Note that this should not commit the removal, it should only prepare for it
1172 to be committed when `rcs_commit` (or `rcs_commit_staged`) is called.
1173
1174 #### `rcs_rename($$)`
1175
1176 Rename a file. The filenames are relative to the root of the srcdir.
1177
1178 Note that this should not commit the rename, it should only
1179 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
1180 The new filename may be in a new subdir, that is not yet added to
1181 version control. If so, the subdir will exist already, and should
1182 be added to revision control.
1183
1184 #### `rcs_recentchanges($)`
1185
1186 Examine the RCS history and generate a list of recent changes.
1187 The parameter is how many changes to return.
1188
1189 The data structure returned for each change is:
1190
1191         {
1192                 rev => # the RCSs id for this commit
1193                 user => # user who made the change (may be an openid),
1194                 nickname => # short name for user (optional; not an openid),
1195                 
1196                 committype => # either "web" or the name of the rcs,
1197                 when => # time when the change was made,
1198                 message => [
1199                         { line => "commit message line 1" },
1200                         { line => "commit message line 2" },
1201                         # etc,
1202                 ],
1203                 pages => [
1204                         {
1205                                 page => # name of page changed,
1206                                 diffurl => # optional url to a diff of changes
1207                         },
1208                         # repeat for each page changed in this commit,
1209                 ],
1210         }
1211
1212 #### `rcs_diff($;$)`
1213
1214 The first parameter is the rev from `rcs_recentchanges`.
1215 The optional second parameter is how many lines to return (default: all).
1216
1217 Should return a list of lines of the diff (including \n) in list
1218 context, and a string containing the whole diff in scalar context.
1219
1220 #### `rcs_getctime($)`
1221
1222 This is used to get the page creation time for a file from the RCS, by looking
1223 it up in the history.
1224
1225 If the RCS cannot determine a ctime for the file, return 0.
1226
1227 #### `rcs_getmtime($)`
1228
1229 This is used to get the page modification time for a file from the RCS, by
1230 looking it up in the history.
1231
1232 It's ok if this is not implemented, and throws an error.
1233
1234 If the RCS cannot determine a mtime for the file, return 0.
1235
1236 #### `rcs_receive()`
1237
1238 This is called when ikiwiki is running as a pre-receive hook (or
1239 equivalent), and is testing if changes pushed into the RCS from an
1240 untrusted user should be accepted. This is optional, and doesn't make
1241 sense to implement for all RCSs.
1242
1243 It should examine the incoming changes, and do any sanity 
1244 checks that are appropriate for the RCS to limit changes to safe file adds,
1245 removes, and changes. If something bad is found, it should die, to abort
1246 the push. Otherwise, it should return a list of files that were changed,
1247 in the form:
1248
1249         {
1250                 file => # name of file that was changed
1251                 action => # either "add", "change", or "remove"
1252                 path => # temp file containing the new file content, only
1253                         # needed for "add"/"change", and only if the file
1254                         # is an attachment, not a page
1255         }
1256
1257 The list will then be checked to make sure that each change is one that
1258 is allowed to be made via the web interface.
1259
1260 #### `rcs_preprevert($)`
1261
1262 This is called by the revert web interface. It is passed a RCS-specific
1263 change ID, and should determine what the effects would be of reverting
1264 that change, and return the same data structure as `rcs_receive`.
1265
1266 Like `rcs_receive`, it should do whatever sanity checks are appropriate
1267 for the RCS to limit changes to safe changes, and die if a change would
1268 be unsafe to revert.
1269
1270 #### `rcs_revert($)`
1271
1272 This is called by the revert web interface. It is passed a named
1273 parameter rev that is the RCS-specific change ID to revert.
1274
1275 It should try to revert the specified rev, and leave the reversion staged
1276 so `rcs_commit_staged` will complete it. It should return undef on _success_
1277 and an error message on failure.
1278
1279 This hook and `rcs_preprevert` are optional, if not implemented, no revert
1280 web interface will be available.
1281
1282 ### `rcs_find_changes($)`
1283
1284 Finds changes committed since the passed RCS-specific rev. Returns
1285 a hash of the files changed, a hash of the files deleted, and the
1286 current rev.
1287
1288 This hook is optional.
1289
1290 ### `rcs_get_current_rev()`
1291
1292 Gets a RCS-specific rev, which can later be passed to `rcs_find_changes`.
1293
1294 This hook is optional.
1295
1296 ### PageSpec plugins
1297
1298 It's also possible to write plugins that add new functions to
1299 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
1300 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
1301 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
1302 two parameters: The name of the page being matched, and the thing to match
1303 against. It may also be passed additional, named parameters.
1304
1305 It should return a IkiWiki::SuccessReason object if the match succeeds, or
1306 an IkiWiki::FailReason object if the match fails. If the match cannot be
1307 attempted at all, for any page, it can instead return an
1308 IkiWiki::ErrorReason object explaining why.
1309
1310 When constructing these objects, you should also include information about
1311 of any pages whose contents or other metadata influenced the result of the
1312 match. Do this by passing a list of pages, followed by `deptype` values.
1313
1314 For example, "backlink(foo)" is influenced by the contents of page foo;
1315 "link(foo)" and "title(bar)" are influenced by the contents of any page
1316 they match; "created_before(foo)" is influenced by the metadata of foo;
1317 while "glob(*)" is not influenced by the contents of any page.
1318
1319 ### Sorting plugins
1320
1321 Similarly, it's possible to write plugins that add new functions as
1322 [[ikiwiki/pagespec/sorting]] methods. To achieve this, add a function to
1323 the IkiWiki::SortSpec package named `cmp_foo`, which will be used when sorting
1324 by `foo` or `foo(...)` is requested.
1325
1326 The names of pages to be compared are in the global variables `$a` and `$b`
1327 in the IkiWiki::SortSpec package. The function should return the same thing
1328 as Perl's `cmp` and `<=>` operators: negative if `$a` is less than `$b`,
1329 positive if `$a` is greater, or zero if they are considered equal. It may
1330 also raise an error using `error`, for instance if it needs a parameter but
1331 one isn't provided.
1332
1333 The function will also be passed one or more parameters. The first is
1334 `undef` if invoked as `foo`, or the parameter `"bar"` if invoked as `foo(bar)`;
1335 it may also be passed additional, named parameters.
1336
1337 ### Setup plugins
1338
1339 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
1340 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
1341 and the rest of the file is passed to that module's import method.
1342
1343 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
1344 can be used to configure ikiwiki in different ways. These modules should,
1345 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
1346 to a hash containing all the config items. They should also implement a
1347 `gendump` function.
1348
1349 By the way, to parse a ikiwiki setup file and populate `%config`, a
1350 program just needs to do something like:
1351 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`
1352
1353 ### Function overriding
1354
1355 Sometimes using ikiwiki's pre-defined hooks is not enough. Your plugin
1356 may need to replace one of ikiwiki's own functions with a modified version,
1357 or wrap one of the functions.
1358
1359 For example, your plugin might want to override `displaytime`, to change
1360 the html markup used when displaying a date. Or it might want to override
1361 `IkiWiki::formattime`, to change how a date is formatted. Or perhaps you
1362 want to override `bestlink` and change how ikiwiki deals with [[WikiLinks|ikiwiki/WikiLink]].
1363
1364 By venturing into this territory, your plugin is becoming tightly tied to
1365 ikiwiki's internals. And it might break if those internals change. But
1366 don't let that stop you, if you're brave.
1367
1368 Ikiwiki provides an `inject()` function, that is a powerful way to replace
1369 any function with one of your own. This even allows you to inject a
1370 replacement for an exported function, like `bestlink`. Everything that
1371 imports that function will get your version instead. Pass it the name of
1372 the function to replace, and a new function to call. 
1373
1374 For example, here's how to replace `displaytime` with a version using HTML 5
1375 markup:
1376
1377         inject(name => 'IkiWiki::displaytime', call => sub {
1378                 return "<time>".formattime(@_)."</time>";
1379         });
1380
1381 Here's how to wrap `bestlink` with a version that tries to handle
1382 plural words:
1383
1384         my $origbestlink=\&bestlink;
1385         inject(name => 'IkiWiki::bestlink', call => \&mybestlink);
1386
1387         sub deplural ($) {
1388                 my $word=shift;
1389                 $word =~ s/e?s$//; # just an example :-)
1390                 return $word;
1391         }
1392
1393         sub mybestlink ($$) {
1394                 my $page=shift;
1395                 my $link=shift;
1396                 my $ret=$origbestlink->($page, $link);
1397                 if (! length $ret) {
1398                         $ret=$origbestlink->($page, deplural($link));
1399                 }
1400                 return $ret;
1401         }
1402
1403 ### Javascript
1404
1405 Some plugins use javascript to make ikiwiki look a bit more web-2.0-ish.
1406
1407 All javascript code should be put in `.js` files in the `javascript`
1408 underlay, and plugins using those files can enable use of the underlay by
1409 calling `add_underlay("javascript");` in their `import` function.
1410
1411 You'll have to arrange for `<script>` tags to be added to the pages that
1412 use your javascript. This can be done using a `format` hook.
1413
1414 Ikiwiki provides some utility functions in `ikiwiki.js`, for use by other
1415 javascript code. These include:
1416
1417 #### `getElementsByClass(cls, node, tag)` 
1418
1419 Returns an array of elements with the given class. The node and tag are
1420 optional and define what document node and element names to search.
1421
1422 #### `hook(name, call)`
1423
1424 The function `call` will be run as part of the hook named `name`.
1425
1426 Note that to hook into `window.onload`, you can use the `onload' hook.
1427
1428 #### `run_hooks(name)`
1429
1430 Runs the hooks with the specified name.