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