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::hook to hook into
21 ikiwiki's processing. The function uses named parameters, and use varies depending on the type of plugin being registered. Note that a plugin can call the function more than once to register multiple hooks. All calls to IkiWiki::hook should be passed a "type" parameter, which gives the type of hook, a "id" paramter, which should be a unique string for this plugin, and a "call" parameter, which is a reference to a function to call for the hook.
22
23 ## Writing a [[PreProcessorDirective]]
24
25 This is probably the most common use of a plugin.
26
27         IkiWiki::hook(type => "preprocess", id => "foo", call => \&preprocess);
28
29 Replace "foo" with the command name that will be used inside brackers for the preprocessor directive.
30
31 Each time the directive is processed, the referenced function (`preprocess` in the example above) is called, and is passed named parameters. A
32 "page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included
33 as named parameters as well. Whatever the function returns goes onto the
34 page in place of the directive.
35
36 ### Error handing
37
38 While a plugin can call ikiwiki's error routine for a fatal error, for
39 errors that aren't intended to halt the entire wiki build, including bad
40 parameters passed to a [[PreProcessorDirective]], etc, it's better to just
41 return the error message as the output of the plugin.
42
43 ### Html issues
44
45 Note that if [[HTMLSanitization]] is enabled, html in 
46 [[PreProcessorDirective]] output is sanitised, which may limit what your
47 plugin can do. Also, the rest of the page content is not in html format at
48 preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
49
50 ## Other types of hooks
51
52 Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include:
53
54 ### checkconfig
55
56         IkiWiki::hook(type => "delete", id => "foo", call => \&checkconfig);
57
58 This is useful if the plugin needs to check for, or modify ikiwiki's configuration. It's called early in the ikiwiki startup process. It's ok for
59 the function to call IkiWiki::error if something isn't configured right.
60
61 ### delete
62
63         IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
64
65 Each time a page or pages is removed from the wiki, the referenced function is called, and passed the names of the source files that were removed.
66
67 ### render
68
69         IkiWiki::hook(type => "render", id => "foo", call => \&render);
70
71 Each time ikiwiki renders a change or addition (but not deletion) of a page to the wiki, the referenced function is called, and passed the name of the source file that was rendered.
72
73 ## Wiki configuration
74
75 A plugin can access the wiki's configuration via the `%IkiWiki::config` hash.
76 The best way to understand the contents of the hash is to look at
77 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
78
79 ## Wiki data
80
81 If your plugin needs to access data about other pages in the wiki. It can
82 use the following hashes, using a page name as the key:
83
84 * `%IkiWiki::links` lists the names of each page
85   that a page links to, in an array reference.
86 * `%IkiWiki::pagemtime` contains the last modification time of each page
87 * `%IkiWiki::pagectime` contains the creation time of each page
88 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
89   page
90 * `%IkiWiki::pagesources` contains the name of the source file for a page.
91 * `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
92   pages that a page depends on. If one of its dependencies is updated, the
93   page will also get rebuilt. 
94   
95   Many plugins will need to add dependencies to this hash; the best way to do
96   it is by using the IkiWiki::add_depends function, which takes as its
97   parameters the page name and a [[GlobList]] of dependencies to add.
98
99 ## RCS plugins
100
101 ikiwiki's support for revision control systems also uses pluggable perl
102 modules. These are in the `IkiWiki::RCS` namespace, for example
103 `IkiWiki::RCS::svn`. 
104
105 Each RCS plugin must support all the IkiWiki::rcs_* functions.
106 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
107 rcs_getctime does nothing except for throwing an error.