* Added smiley plugin, nicely controlled and documented by the smileys page.
[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` in the example above) is called, and is passed named parameters. A
39 "page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included
40 as named parameters as well. Whatever the function returns goes onto the
41 page in place of the directive.
42
43 ### Error handing
44
45 While a plugin can call ikiwiki's error routine for a fatal error, for
46 errors that aren't intended to halt the entire wiki build, including bad
47 parameters passed to a [[PreProcessorDirective]], etc, it's better to just
48 return the error message as the output of the plugin.
49
50 ### Html issues
51
52 Note that if [[HTMLSanitization]] is enabled, html in 
53 [[PreProcessorDirective]] output is sanitised, which may limit what your
54 plugin can do. Also, the rest of the page content is not in html format at
55 preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
56
57 ## Other types of hooks
58
59 Beyond PreProcessorDirectives, Other types of hooks that can be used by
60 plugins include:
61
62 ### checkconfig
63
64         IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
65
66 This is useful if the plugin needs to check for, or modify ikiwiki's
67 configuration. It's called early in the ikiwiki startup process. The
68 function is passed no values. It's ok for the function to call
69 IkiWiki::error if something isn't configured right.
70
71 ### filter
72
73         IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
74
75 Runs on the raw source of a page, before anything else touches it, and can
76 make arbitrary changes. The function is passed named parameters `page` and
77 `content` should return the filtered content.
78
79 ### delete
80
81         IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
82
83 Each time a page or pages is removed from the wiki, the referenced function
84 is called, and passed the names of the source files that were removed.
85
86 ### render
87
88         IkiWiki::hook(type => "render", id => "foo", call => \&render);
89
90 Each time ikiwiki renders a change or addition (but not deletion) of a page
91 to the wiki, the referenced function is called, and passed the name of the
92 source file that was rendered.
93
94 ### cgi
95
96         IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
97
98 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
99 called in turn, and passed a CGI object. The hook should examine the
100 parameters, and if it will handle this CGI request, output a page and
101 terminate the program.
102
103 ## Wiki configuration
104
105 A plugin can access the wiki's configuration via the `%IkiWiki::config`
106 hash. The best way to understand the contents of the hash is to look at
107 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
108
109 ## Wiki data
110
111 If your plugin needs to access data about other pages in the wiki. It can
112 use the following hashes, using a page name as the key:
113
114 * `%IkiWiki::links` lists the names of each page
115   that a page links to, in an array reference.
116 * `%IkiWiki::pagemtime` contains the last modification time of each page
117 * `%IkiWiki::pagectime` contains the creation time of each page
118 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
119   page
120 * `%IkiWiki::pagesources` contains the name of the source file for a page.
121 * `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
122   pages that a page depends on. If one of its dependencies is updated, the
123   page will also get rebuilt. 
124   
125   Many plugins will need to add dependencies to this hash; the best way to do
126   it is by using the IkiWiki::add_depends function, which takes as its
127   parameters the page name and a [[GlobList]] of dependencies to add.
128
129 ## Page templates
130
131 Plugins are mostly limited to changing the content of pages, to change the
132 look and feel of the wiki it's generally better to use a stylesheet and
133 [[templates]]. However, there are some hooks in the templates that plugins
134 can use to add stuff to the wiki's UI:
135
136 ### Adding content to the page header
137
138 Html that is added to $IkiWiki::config{headercontent} will show up in the
139 header of the page. One good thing to put here is a search form.
140
141 ## RCS plugins
142
143 ikiwiki's support for revision control systems also uses pluggable perl
144 modules. These are in the `IkiWiki::RCS` namespace, for example
145 `IkiWiki::RCS::svn`. 
146
147 Each RCS plugin must support all the IkiWiki::rcs\_* functions.
148 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
149 rcs\_getctime does nothing except for throwing an error.