* Switch pagetemplate hooks to using named parameters.
[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 ## checkconfig
68
69         IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
70
71 This is useful if the plugin needs to check for, or modify ikiwiki's
72 configuration. It's called early in the ikiwiki startup process. The
73 function is passed no values. It's ok for the function to call
74 IkiWiki::error if something isn't configured right.
75
76 ## filter
77
78         IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
79
80 Runs on the raw source of a page, before anything else touches it, and can
81 make arbitrary changes. The function is passed named parameters `page` and
82 `content` and should return the filtered content.
83
84 ## htmlize
85
86         IkiWiki::hook(type => "htmlize", id => "ext", call => \&filter);
87
88 Runs on the raw source of a page and turns it into html. The id parameter
89 specifies the filename extension that a file must have to be htmlized using
90 this plugin. This is how you can add support for new and exciting markup
91 languages to ikiwiki.
92
93 ## pagetemplate
94
95         IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
96
97 Each time a page is rendered, a [[template|templates]] is filled out.
98 This hook allows modifying that template. The function is passed named
99 parameters. The "page" and "destpage" parameters are the same as for a
100 preprocess hook. The "template" parameter is a `HTML::Template` object that
101 is the template that will be used to generate the page. The function 
102 can manipulate that template object.
103
104 The most common thing to do is probably to call $template->param() to add
105 a new custom parameter to the template. Note that in order to be robust,
106 it's a good idea to check whether the template has a variable before trying
107 to set it, as setting a variable that's not present is an error.
108
109         if ($template->query(name => 'foo')) {
110                 $template->param("foo" => "bar");
111         }
112
113 ## sanitize
114
115         IkiWiki::hook(type => "sanitize", id => "foo", call => \&sanitize);
116
117 Use this to implement html sanitization or anything else that needs to
118 modify the content of a page after it has been fully converted to html.
119 The function is passed the page content and should return the sanitized
120 content.
121
122 ## delete
123
124         IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
125
126 Each time a page or pages is removed from the wiki, the referenced function
127 is called, and passed the names of the source files that were removed.
128
129 ## change
130
131         IkiWiki::hook(type => "change", id => "foo", call => \&render);
132
133 Each time ikiwiki renders a change or addition (but not deletion) to the
134 wiki, the referenced function is called, and passed the names of the
135 source files that were rendered.
136
137 ## cgi
138
139         IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
140
141 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
142 called in turn, and passed a CGI object. The hook should examine the
143 parameters, and if it will handle this CGI request, output a page and
144 terminate the program.
145
146 # Wiki configuration
147
148 A plugin can access the wiki's configuration via the `%IkiWiki::config`
149 hash. The best way to understand the contents of the hash is to look at
150 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
151
152 # Wiki data
153
154 If your plugin needs to access data about other pages in the wiki. It can
155 use the following hashes, using a page name as the key:
156
157 * `%IkiWiki::links` lists the names of each page
158   that a page links to, in an array reference.
159 * `%IkiWiki::pagemtime` contains the last modification time of each page
160 * `%IkiWiki::pagectime` contains the creation time of each page
161 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
162   page
163 * `%IkiWiki::pagesources` contains the name of the source file for a page.
164 * `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
165   pages that a page depends on. If one of its dependencies is updated, the
166   page will also get rebuilt. 
167   
168   Many plugins will need to add dependencies to this hash; the best way to do
169   it is by using the IkiWiki::add_depends function, which takes as its
170   parameters the page name and a [[GlobList]] of dependencies to add.
171
172 # RCS plugins
173
174 ikiwiki's support for revision control systems also uses pluggable perl
175 modules. These are in the `IkiWiki::RCS` namespace, for example
176 `IkiWiki::RCS::svn`. 
177
178 Each RCS plugin must support all the IkiWiki::rcs\_* functions.
179 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
180 rcs\_getctime does nothing except for throwing an error.
181
182 See [[about_RCS_backends]] for some more info.