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