web commit by joey
[ikiwiki.git] / doc / plugins / write.mdwn
1 ikiwiki [[plugins]] are written in perl. Each plugin is a perl module, in
2 the `IkiWiki::Plugin` namespace. The name of the plugin is typically in
3 lowercase, such as `IkiWiki::Plugin::inline`. Ikiwiki includes a
4 `IkiWiki::Plugin::skeleton` that can be fleshed out to make a useful
5 plugin. `IkiWiki::Plugin::pagecount` is another simple example.
6
7 ## Note
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. Also, as a compiler, ikiwiki avoids
13 rebuilding pages unless they have changed, so a plugin that prints some
14 random or changing thing on a page will generate a static page that won't
15 change until ikiwiki rebuilds the page for some other reason, like the page
16 being edited.
17
18 ## Registering plugins
19
20 Plugins should, when imported, call IkiWiki::register_plugin to hook into
21 ikiwiki. The function takes four parameters:
22
23 1. A method type. Use "preprocess" to register a [[PreProcessorDirective]]
24 2. A command name. This is the bit that will appear inside brackets in a
25    page.
26 3. A reference to a subroutine that is run when the plugin is used.
27
28 ## Writing a [[PreProcessorDirective]]
29
30 For preprocessor directives, the subroutine is passed named parameters. A
31 "page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included
32 as named parameters as well. Whatever the subroutine returns goes onto the
33 page in place of the directive.
34
35 ## Error handing in plugins
36
37 While a plugin can call ikiwiki's error routine for a fatal error, for
38 errors that aren't intended to halt the entire wiki build, including bad
39 parameters passed to a [[PreProcessorDirective]], etc, it's better to just
40 return the error message as the output of the plugin.
41
42 ## Html issues
43
44 Note that if [[HTMLSanitization]] is enabled, html in 
45 [[PreProcessorDirective]] output is sanitised, which may limit what your
46 plugin can do. Also, the rest of the page content is not in html format at
47 preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
48
49 ## Wiki configuration
50
51 A plugin can access the wiki's configuration via the `%IkiWiki::config` hash.
52 The best way to understand the contents of the hash is to look at
53 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
54
55 ## Wiki data
56
57 If your plugin needs to access data about other pages in the wiki. It can
58 use the following hashes, using a page name as the key:
59
60 * `%IkiWiki::links` lists the names of each page
61   that a page links to, in an array reference.
62 * `%IkiWiki::pagemtime` contains the last modification time of each page
63 * `%IkiWiki::pagectime` contains the creation time of each page`
64 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
65   page
66 * `%IkiWiki::pagesources` contains the name of the source file for a page.
67 * `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
68   pages that a page depends on. If one of its dependencies is updated, the
69   page will also get rebuilt. 
70   
71   Many plugins will need to add dependencies to this hash; the best way to do
72   it is by using the IkiWiki::add_depends function, which takes as its
73   parameters the page name and a [[GlobList]] of dependencies to add.