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 [[toc levels=2]]
   8
   9 ## Considerations
  10
  11 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
  12 *compiler*. So plugins influence pages when they are built, not when they
  13 are loaded. A plugin that inserts the current time into a page, for
  14 example, will insert the build time. Also, as a compiler, ikiwiki avoids
  15 rebuilding pages unless they have changed, so a plugin that prints some
  16 random or changing thing on a page will generate a static page that won't
  17 change until ikiwiki rebuilds the page for some other reason, like the page
  18 being edited.
  19
  20 ## Registering plugins
  21
  22 All plugins should `use IkiWiki` to import the ikiwiki plugin interface.
  23
  24 Plugins should, when imported, call `hook()` to hook into ikiwiki's
  25 processing. The function uses named parameters, and use varies depending on
  26 the type of hook being registered -- see below. Note that a plugin can call
  27 the function more than once to register multiple hooks. All calls to
  28 `hook()` should be passed a "type" parameter, which gives the type of
  29 hook, a "id" paramter, which should be a unique string for this plugin, and
  30 a "call" parameter, which is a reference to a function to call for the
  31 hook.
  32
  33 ## Types of hooks
  34
  35 In roughly the order they are called.
  36
  37 ### getopt
  38
  39         hook(type => "getopt", id => "foo", call => \&getopt);
  40
  41 This allows for plugins to perform their own processing of command-line
  42 options and so add options to the ikiwiki command line. It's called during
  43 command line processing, with @ARGV full of any options that ikiwiki was
  44 not able to process on its own. The function should process any options it
  45 can, removing them from @ARGV, and probably recording the configuration
  46 settings in %config. It should take care not to abort if it sees
  47 an option it cannot process, and should just skip over those options and
  48 leave them in @ARGV.
  49
  50 ### checkconfig
  51
  52         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
  53
  54 This is useful if the plugin needs to check for or modify ikiwiki's
  55 configuration. It's called early in the startup process. The
  56 function is passed no values. It's ok for the function to call
  57 `error()` if something isn't configured right.
  58
  59 ### filter
  60
  61         hook(type => "filter", id => "foo", call => \&filter);
  62
  63 Runs on the raw source of a page, before anything else touches it, and can
  64 make arbitrary changes. The function is passed named parameters `page` and
  65 `content` and should return the filtered content.
  66
  67 ### preprocess
  68
  69 Adding a [[PreProcessorDirective]] is probably the most common use of a
  70 plugin.
  71
  72         hook(type => "preprocess", id => "foo", call => \&preprocess);
  73
  74 Replace "foo" with the command name that will be used inside brackets for
  75 the preprocessor directive.
  76
  77 Each time the directive is processed, the referenced function (`preprocess`
  78 in the example above) is called, and is passed named parameters. A "page"
  79 parameter gives the name of the page that embedded the preprocessor
  80 directive, while a "destpage" parameter gices the name of the page the
  81 content is going to (different for inlined pages). All parameters included
  82 in the directive are included as named parameters as well. Whatever the
  83 function returns goes onto the page in place of the directive.
  84
  85 Note that if the [[htmlscrubber]] is enabled, html in
  86 [[PreProcessorDirective]] output is sanitised, which may limit what your
  87 plugin can do. Also, the rest of the page content is not in html format at
  88 preprocessor time. Text output by a preprocessor directive will be
  89 linkified and passed through markdown (or whatever engine is used to htmlize
  90 the page) along with the rest of the page.
  91
  92 ### htmlize
  93
  94         hook(type => "htmlize", id => "ext", call => \&htmlize);
  95
  96 Runs on the raw source of a page and turns it into html. The id parameter
  97 specifies the filename extension that a file must have to be htmlized using
  98 this plugin. This is how you can add support for new and exciting markup
  99 languages to ikiwiki.
 100
 101 The function is passed named parameters: "page" and "content" and should
 102 return the htmlized content.
 103
 104 ### pagetemplate
 105
 106         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
 107
 108 [[Templates]] are filled out for many different things in ikiwiki,
 109 like generating a page, or part of a blog page, or an rss feed, or a cgi.
 110 This hook allows modifying those templates. The function is passed named
 111 parameters. The "page" and "destpage" parameters are the same as for a
 112 preprocess hook. The "template" parameter is a `HTML::Template` object that
 113 is the template that will be used to generate the page. The function can
 114 manipulate that template object.
 115
 116 The most common thing to do is probably to call $template->param() to add
 117 a new custom parameter to the template.
 118
 119 ### sanitize
 120
 121         hook(type => "sanitize", id => "foo", call => \&sanitize);
 122
 123 Use this to implement html sanitization or anything else that needs to
 124 modify the body of a page after it has been fully converted to html.
 125
 126 The function is passed named parameters: "page" and "content", and
 127 should return the sanitized content.
 128
 129 ### format
 130
 131         hook(type => "format", id => "foo", call => \&format);
 132
 133 The difference between format and sanitize is that sanitize only acts on
 134 the page body, while format can modify the entire html page including the
 135 header and footer inserted by ikiwiki, the html document type, etc.
 136
 137 The function is passed named parameters: "page" and "content", and
 138 should return the formatted content.
 139
 140 ### delete
 141
 142         hook(type => "delete", id => "foo", call => \&delete);
 143
 144 Each time a page or pages is removed from the wiki, the referenced function
 145 is called, and passed the names of the source files that were removed.
 146
 147 ### change
 148
 149         hook(type => "change", id => "foo", call => \&render);
 150
 151 Each time ikiwiki renders a change or addition (but not deletion) to the
 152 wiki, the referenced function is called, and passed the names of the
 153 source files that were rendered.
 154
 155 ### cgi
 156
 157         hook(type => "cgi", id => "foo", call => \&cgi);
 158
 159 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
 160 called in turn, and passed a CGI object. The hook should examine the
 161 parameters, and if it will handle this CGI request, output a page and
 162 terminate the program.
 163
 164 ### savestate
 165
 166         hook(type => "savestate", id => "foo", call => \&savestate);
 167
 168 This hook is called wheneven ikiwiki normally saves its state, just before
 169 the state is saved. The function can save other state, modify values before
 170 they're saved, etc.
 171
 172 ## Plugin interface
 173
 174 To import the ikiwiki plugin interface:
 175
 176         use IkiWiki '1.00';
 177
 178 This will import several variables and functions into your plugin's
 179 namespace. These variables and functions are the ones most plugins need,
 180 and a special effort will be made to avoid changing them in incompatible
 181 ways, and to document any changes that have to be made in the future.
 182
 183 Note that IkiWiki also provides other variables functions that are not
 184 exported by default. No guarantee is made about these in the future, so if
 185 it's not exported, the wise choice is to not use it.
 186
 187 ### %config
 188
 189 A plugin can access the wiki's configuration via the `%config`
 190 hash. The best way to understand the contents of the hash is to look at
 191 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
 192
 193 ### Other variables
 194
 195 If your plugin needs to access data about other pages in the wiki. It can
 196 use the following hashes, using a page name as the key:
 197
 198 * `%links` lists the names of each page that a page links to, in an array
 199   reference.
 200 * `%renderedfiles` lists names of the files rendered by a page, in an array
 201   reference.
 202 * `%pagesources` contains the name of the source file for a page.
 203
 204 Also, the %IkiWiki::version variable contains the version number for the
 205 ikiwiki program.
 206
 207 ### Library functions
 208
 209 #### `hook(@)`
 210
 211 Hook into ikiwiki's processing. See the discussion of hooks above.
 212
 213 #### `debug($)`
 214
 215 Logs a debugging message. These are supressed unless verbose mode is turned
 216 on.
 217
 218 #### `error($)`
 219
 220 Aborts with an error message.
 221
 222 Note that while any plugin can use this for a fatal error, plugins should
 223 try to avoid dying on bad input, as that will halt the entire wiki build
 224 and make the wiki unusable. So for example, if a [[PreProcessorDirective]]
 225 is passed bad parameters, it's better to return an error message, which can
 226 appear on the wiki page, rather than calling error().
 227
 228 #### `template($;@)`
 229
 230 Creates and returns a HTML::Template object. The first parameter is the
 231 name of the file in the template directory. The optional remaining
 232 parameters are passed to HTML::Template->new.
 233
 234 #### `htmlpage($)`
 235
 236 Passed a page name, returns the base name that will be used for a the html
 237 page created from it. (Ie, it appends ".html".)
 238
 239 #### `add_depends($$)`
 240
 241 Makes the specified page depend on the specified [[PageSpec]].
 242
 243 #### `pagespec_match($$)`
 244
 245 Passed a page name, and a [[PageSpec]], returns true if the [[PageSpec]]
 246 matches the page.
 247
 248 #### `bestlink($$)`
 249
 250 Given a page and the text of a link on the page, determine which
 251 existing page that link best points to. Prefers pages under a
 252 subdirectory with the same name as the source page, failing that
 253 goes down the directory tree to the base looking for matching
 254 pages, as described in [[SubPage/LinkingRules]].
 255
 256 #### `htmllink($$$;$$$)`
 257
 258 Many plugins need to generate html links and add them to a page. This is
 259 done by using the `htmllink` function. The usual way to call
 260 `htmlllink` is:
 261
 262         htmllink($page, $page, $link)
 263
 264 Why is `$page` repeated? Because if a page is inlined inside another, and a
 265 link is placed on it, the right way to make that link is actually:
 266
 267         htmllink($page, $destpage, $link)
 268
 269 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
 270 some of the hook functions above; the ones that are not passed it are not used
 271 during inlining and don't need to worry about this issue.
 272
 273 The remaining three optional parameters to `htmllink` are:
 274
 275 1. noimageinline - set to true to avoid turning links into inline html images
 276 1. forcesubpage  - set to force a link to a subpage
 277 1. linktext - set to force the link text to something
 278
 279 #### `readfile($;$)`
 280
 281 Given a filename, reads and returns the entire file.
 282
 283 The optional second parameter, if set to a true value, makes the file be read
 284 in binary mode.
 285
 286 A failure to read the file will result in it dying with an error.
 287
 288 #### `writefile($$$;$)`
 289
 290 Given a filename, a directory to put it in, and the file's content,
 291 writes a file.
 292
 293 The optional second parameter, if set to a true value, makes the file be
 294 written in binary mode.
 295
 296 A failure to write the file will result in it dying with an error.
 297
 298 If the destination directory doesn't exist, it will first be created.
 299
 300 ### `will_render($$)`
 301
 302 Given a page name and a destination file name (not including the base
 303 destination directory), register that the page will result in that file
 304 being rendered. It's important to call this before writing to any file in
 305 the destination directory.
 306
 307 #### `pagetype($)`
 308
 309 Given the name of a source file, returns the type of page it is, if it's
 310 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
 311
 312 #### `pagename($)`
 313
 314 Given the name of a source file, returns the name of the wiki page
 315 that corresponds to that file.
 316
 317 #### `srcfile($)`
 318
 319 Given the name of a source file in the wiki, searches for the file in
 320 the source directory and the underlay directory, and returns the full
 321 path to the first file found.
 322
 323 #### `displaytime($)`
 324
 325 Given a time, formats it for display.
 326
 327 ## RCS plugins
 328
 329 ikiwiki's support for revision control systems also uses pluggable perl
 330 modules. These are in the `IkiWiki::RCS` namespace, for example
 331 `IkiWiki::RCS::svn`.
 332
 333 Each RCS plugin must support all the IkiWiki::rcs\_* functions.
 334 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
 335 rcs\_getctime does nothing except for throwing an error.
 336
 337 See [[about_RCS_backends]] for some more info.