26397db65fb6506b8e49efc8ec7a9a1c9239019f
[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 [[toc levels=2]]
8
9 # Note
10
11 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
12 *compiler*. So plugins influence pages when they are built, not when they
13 are loaded. A plugin that inserts the current time into a page, for
14 example, will insert the build time. Also, as a compiler, ikiwiki avoids
15 rebuilding pages unless they have changed, so a plugin that prints some
16 random or changing thing on a page will generate a static page that won't
17 change until ikiwiki rebuilds the page for some other reason, like the page
18 being edited.
19
20 # Registering plugins
21
22 Plugins should, when imported, call IkiWiki::hook to hook into ikiwiki's
23 processing. The function uses named parameters, and use varies depending on
24 the type of plugin being registered. Note that a plugin can call the
25 function more than once to register multiple hooks. All calls to
26 IkiWiki::hook should be passed a "type" parameter, which gives the type of
27 hook, a "id" paramter, which should be a unique string for this plugin, and
28 a "call" parameter, which is a reference to a function to call for the
29 hook.
30
31 # Types of hooks
32
33 In roughly the order they are called.
34
35 ## getopt
36
37         IkiWiki::hook(type => "getopt", id => "foo", call => \&getopt);
38
39 This allows for plugins to perform their own processing of command-line
40 options and so add options to the ikiwiki command line. It's called during
41 command line processing, with @ARGV full of any options that ikiwiki was
42 not able to process on its own. The function should process any options it
43 can, removing them from @ARGV, and probably recording the configuration
44 settings in %IkiWiki::config. It should take care not to abort if it sees
45 an option it cannot process, and should just skip over those options and
46 leave them in @ARGV.
47
48 ## checkconfig
49
50         IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
51
52 This is useful if the plugin needs to check for or modify ikiwiki's
53 configuration. It's called early in the startup process. The
54 function is passed no values. It's ok for the function to call
55 IkiWiki::error if something isn't configured right.
56
57 ## filter
58
59         IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
60
61 Runs on the raw source of a page, before anything else touches it, and can
62 make arbitrary changes. The function is passed named parameters `page` and
63 `content` and should return the filtered content.
64
65 ## preprocess
66
67 Adding a [[PreProcessorDirective]] is probably the most common use of a
68 plugin.
69
70         IkiWiki::hook(type => "preprocess", id => "foo", call => \&preprocess);
71
72 Replace "foo" with the command name that will be used inside brackets for
73 the preprocessor directive.
74
75 Each time the directive is processed, the referenced function (`preprocess`
76 in the example above) is called, and is passed named parameters. A "page"
77 parameter gives the name of the page that embedded the preprocessor
78 directive, while a "destpage" parameter gices the name of the page the
79 content is going to (different for inlined pages). All parameters included
80 in the directive are included as named parameters as well. Whatever the
81 function returns goes onto the page in place of the directive.
82
83 Note that if the [[htmlscrubber]] is enabled, html in
84 [[PreProcessorDirective]] output is sanitised, which may limit what your
85 plugin can do. Also, the rest of the page content is not in html format at
86 preprocessor time. Text output by a preprocessor directive will be
87 linkified and passed through markdown (or whatever engine is used to htmlize
88 the page) along with the rest of the page.
89
90 ## htmlize
91
92         IkiWiki::hook(type => "htmlize", id => "ext", call => \&htmlize);
93
94 Runs on the raw source of a page and turns it into html. The id parameter
95 specifies the filename extension that a file must have to be htmlized using
96 this plugin. This is how you can add support for new and exciting markup
97 languages to ikiwiki.
98
99 The function is passed named parameters: "page" and "content" and should
100 return the htmlized content.
101
102 ## pagetemplate
103
104         IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
105
106 Each time a page (or part of a blog page, or an rss feed) is rendered, a
107 [[template|templates]] is filled out. This hook allows modifying that
108 template. The function is passed named parameters. The "page" and
109 "destpage" parameters are the same as for a preprocess hook. The "template"
110 parameter is a `HTML::Template` object that is the template that will be
111 used to generate the page. The function can manipulate that template
112 object.
113
114 The most common thing to do is probably to call $template->param() to add
115 a new custom parameter to the template.
116
117 ## sanitize
118
119         IkiWiki::hook(type => "sanitize", id => "foo", call => \&sanitize);
120
121 Use this to implement html sanitization or anything else that needs to
122 modify the body of a page after it has been fully converted to html.
123
124 The function is passed named parameters: "page" and "content", and 
125 should return the sanitized content.
126
127 ## format
128
129         IkiWiki::hook(type => "format", id => "foo", call => \&format);
130
131 The difference between format and sanitize is that sanitize only acts on
132 the page body, while format can modify the entire html page including the
133 header and footer inserted by ikiwiki, the html document type, etc.
134
135 The function is passed named parameters: "page" and "content", and 
136 should return the formatted content.
137
138 ## delete
139
140         IkiWiki::hook(type => "delete", id => "foo", call => \&delete);
141
142 Each time a page or pages is removed from the wiki, the referenced function
143 is called, and passed the names of the source files that were removed.
144
145 ## change
146
147         IkiWiki::hook(type => "change", id => "foo", call => \&render);
148
149 Each time ikiwiki renders a change or addition (but not deletion) to the
150 wiki, the referenced function is called, and passed the names of the
151 source files that were rendered.
152
153 ## cgi
154
155         IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
156
157 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
158 called in turn, and passed a CGI object. The hook should examine the
159 parameters, and if it will handle this CGI request, output a page and
160 terminate the program.
161
162 ## savestate
163
164         IkiWiki::hook(type => "savestate", id => "foo", call => \&savestate);
165
166 This hook is called wheneven ikiwiki normally saves its state, just before
167 the state is saved. The function can save other state, modify values before
168 they're saved, etc.
169
170 ## Error handing
171
172 While a plugin can call ikiwiki's error routine for a fatal error, for
173 errors that aren't intended to halt the entire wiki build, including bad
174 parameters passed to a [[PreProcessorDirective]], etc, it's better to just
175 return the error message as the output of the plugin.
176
177 # Wiki configuration
178
179 A plugin can access the wiki's configuration via the `%IkiWiki::config`
180 hash. The best way to understand the contents of the hash is to look at
181 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
182
183 # Wiki data
184
185 If your plugin needs to access data about other pages in the wiki. It can
186 use the following hashes, using a page name as the key:
187
188 * `%IkiWiki::links` lists the names of each page
189   that a page links to, in an array reference.
190 * `%IkiWiki::pagemtime` contains the last modification time of each page
191 * `%IkiWiki::pagectime` contains the creation time of each page
192 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
193   page
194 * `%IkiWiki::pagesources` contains the name of the source file for a page.
195 * `%IkiWiki::depends` contains a [[PageSpec]] that is used to specify other
196   pages that a page depends on. If one of its dependencies is updated, the
197   page will also get rebuilt. 
198   
199   Many plugins will need to add dependencies to this hash; the best way to do
200   it is by using the IkiWiki::add_depends function, which takes as its
201   parameters the page name and a [[PageSpec]] of dependencies to add.
202 * `%IkiWiki::forcerebuild` any pages set as the keys to this hash will be
203   treated as if they're modified and rebuilt.
204
205 # A note on generating html links
206
207 Many plugins need to generate html links and add them to a page. This is
208 done by using the `IkiWiki::htmllink` function. The usual way to call
209 htmlllink is:
210
211         htmllink($page, $page, $link)
212
213 Why is $page repeated? Because if a page is inlined inside another, and a
214 link is placed on it, the right way to make that link is actually:
215
216         htmllink($page, $destpage, $link)
217
218 Here $destpage is the inlining page. A destpage parameter is passed to some
219 of the hook functions above; the ones that are not passed it are not used
220 during inlining and don't need to worry about this issue.
221
222 # RCS plugins
223
224 ikiwiki's support for revision control systems also uses pluggable perl
225 modules. These are in the `IkiWiki::RCS` namespace, for example
226 `IkiWiki::RCS::svn`. 
227
228 Each RCS plugin must support all the IkiWiki::rcs\_* functions.
229 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
230 rcs\_getctime does nothing except for throwing an error.
231
232 See [[about_RCS_backends]] for some more info.