doc/plugins/write.mdwn

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