* Support htmlize plugins and make mdwn one such plugin, which is enabled by
[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. All parameters included in the directive are included as named
42 parameters as well. Whatever the function returns goes onto the page in
43 place of the directive.
44
45 ## Error handing
46
47 While a plugin can call ikiwiki's error routine for a fatal error, for
48 errors that aren't intended to halt the entire wiki build, including bad
49 parameters passed to a [[PreProcessorDirective]], etc, it's better to just
50 return the error message as the output of the plugin.
51
52 ## Html issues
53
54 Note that if the [[htmlscrubber]] is enabled, html in
55 [[PreProcessorDirective]] output is sanitised, which may limit what your
56 plugin can do. Also, the rest of the page content is not in html format at
57 preprocessor time. Text output by a preprocessor directive will be passed
58 through markdown (or whatever engine is used to htmlize the page) along
59 with the rest of the page.
60
61 # Other types of hooks
62
63 Beyond PreProcessorDirectives, Other types of hooks that can be used by
64 plugins include:
65
66 ## checkconfig
67
68         IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
69
70 This is useful if the plugin needs to check for, or modify ikiwiki's
71 configuration. It's called early in the ikiwiki startup process. The
72 function is passed no values. It's ok for the function to call
73 IkiWiki::error if something isn't configured right.
74
75 ## filter
76
77         IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
78
79 Runs on the raw source of a page, before anything else touches it, and can
80 make arbitrary changes. The function is passed named parameters `page` and
81 `content` and should return the filtered content.
82
83 ## htmlize
84
85         IkiWiki::hook(type => "htmlize", id => "ext", call => \&filter);
86
87 Runs on the raw source of a page and turns it into html. The id parameter
88 specifies the filename extension that a file must have to be htmlized using
89 this plugin. This is how you can add support for new and exciting markup
90 languages to ikiwiki.
91
92 ## pagetemplate
93
94         IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
95
96 Each time a page is rendered, a [[template|templates]] is filled out.
97 This hook allows modifying that template. The function is passed the name
98 of the page, and a `HTML::Template` object that is the template that will
99 be used to generate the page. It can manipulate that template, the most
100 common thing to do is probably to call $template->param() to add a new
101 custom parameter to the template.
102
103 ## sanitize
104
105         IkiWiki::hook(type => "sanitize", id => "foo", call => \&sanitize);
106
107 Use this to implement html sanitization or anything else that needs to
108 modify the content of a page after it has been fully converted to html.
109 The function is passed the page content and should return the sanitized
110 content.
111
112 ## delete
113
114         IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
115
116 Each time a page or pages is removed from the wiki, the referenced function
117 is called, and passed the names of the source files that were removed.
118
119 ## change
120
121         IkiWiki::hook(type => "change", id => "foo", call => \&render);
122
123 Each time ikiwiki renders a change or addition (but not deletion) to the
124 wiki, the referenced function is called, and passed the names of the
125 source files that were rendered.
126
127 ## cgi
128
129         IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
130
131 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
132 called in turn, and passed a CGI object. The hook should examine the
133 parameters, and if it will handle this CGI request, output a page and
134 terminate the program.
135
136 # Wiki configuration
137
138 A plugin can access the wiki's configuration via the `%IkiWiki::config`
139 hash. The best way to understand the contents of the hash is to look at
140 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
141
142 # Wiki data
143
144 If your plugin needs to access data about other pages in the wiki. It can
145 use the following hashes, using a page name as the key:
146
147 * `%IkiWiki::links` lists the names of each page
148   that a page links to, in an array reference.
149 * `%IkiWiki::pagemtime` contains the last modification time of each page
150 * `%IkiWiki::pagectime` contains the creation time of each page
151 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
152   page
153 * `%IkiWiki::pagesources` contains the name of the source file for a page.
154 * `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
155   pages that a page depends on. If one of its dependencies is updated, the
156   page will also get rebuilt. 
157   
158   Many plugins will need to add dependencies to this hash; the best way to do
159   it is by using the IkiWiki::add_depends function, which takes as its
160   parameters the page name and a [[GlobList]] of dependencies to add.
161
162 # RCS plugins
163
164 ikiwiki's support for revision control systems also uses pluggable perl
165 modules. These are in the `IkiWiki::RCS` namespace, for example
166 `IkiWiki::RCS::svn`. 
167
168 Each RCS plugin must support all the IkiWiki::rcs\_* functions.
169 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
170 rcs\_getctime does nothing except for throwing an error.
171
172 See [[about_RCS_backends]] for some more info.