git.oblomov.eu Git - ikiwiki/blob - 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
  21 ikiwiki's processing. The function uses named parameters, and use varies depending on the type of plugin being registered. Note that a plugin can call the function more than once to register multiple hooks. All calls to IkiWiki::hook should be passed a "type" parameter, which gives the type of hook, a "id" paramter, which should be a unique string for this plugin, and a "call" parameter, which is a reference to a function to call for the hook.
  22
  23 ## Writing a [[PreProcessorDirective]]
  24
  25 This is probably the most common use of a plugin.
  26
  27         IkiWiki::hook(type => "preprocess", id => "foo", call => \&preprocess);
  28
  29 Replace "foo" with the command name that will be used inside brackers for the preprocessor directive.
  30
  31 Each time the directive is processed, the referenced function (`preprocess` in the example above) is called, and is passed named parameters. A
  32 "page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included
  33 as named parameters as well. Whatever the function returns goes onto the
  34 page in place of the directive.
  35
  36 ### Error handing
  37
  38 While a plugin can call ikiwiki's error routine for a fatal error, for
  39 errors that aren't intended to halt the entire wiki build, including bad
  40 parameters passed to a [[PreProcessorDirective]], etc, it's better to just
  41 return the error message as the output of the plugin.
  42
  43 ### Html issues
  44
  45 Note that if [[HTMLSanitization]] is enabled, html in
  46 [[PreProcessorDirective]] output is sanitised, which may limit what your
  47 plugin can do. Also, the rest of the page content is not in html format at
  48 preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
  49
  50 ## Other types of hooks
  51
  52 Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include:
  53
  54 ### checkconfig
  55
  56         IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
  57
  58 This is useful if the plugin needs to check for, or modify ikiwiki's configuration. It's called early in the ikiwiki startup process. The function is passed no values. It's ok for the function to call IkiWiki::error if something isn't configured right.
  59
  60 ### delete
  61
  62         IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
  63
  64 Each time a page or pages is removed from the wiki, the referenced function is called, and passed the names of the source files that were removed.
  65
  66 ### render
  67
  68         IkiWiki::hook(type => "render", id => "foo", call => \&render);
  69
  70 Each time ikiwiki renders a change or addition (but not deletion) of a page to the wiki, the referenced function is called, and passed the name of the source file that was rendered.
  71
  72 ## Wiki configuration
  73
  74 A plugin can access the wiki's configuration via the `%IkiWiki::config` hash.
  75 The best way to understand the contents of the hash is to look at
  76 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
  77
  78 ## Wiki data
  79
  80 If your plugin needs to access data about other pages in the wiki. It can
  81 use the following hashes, using a page name as the key:
  82
  83 * `%IkiWiki::links` lists the names of each page
  84   that a page links to, in an array reference.
  85 * `%IkiWiki::pagemtime` contains the last modification time of each page
  86 * `%IkiWiki::pagectime` contains the creation time of each page
  87 * `%IkiWiki::renderedfiles` contains the name of the file rendered by a
  88   page
  89 * `%IkiWiki::pagesources` contains the name of the source file for a page.
  90 * `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
  91   pages that a page depends on. If one of its dependencies is updated, the
  92   page will also get rebuilt.
  93
  94   Many plugins will need to add dependencies to this hash; the best way to do
  95   it is by using the IkiWiki::add_depends function, which takes as its
  96   parameters the page name and a [[GlobList]] of dependencies to add.
  97
  98 ## RCS plugins
  99
 100 ikiwiki's support for revision control systems also uses pluggable perl
 101 modules. These are in the `IkiWiki::RCS` namespace, for example
 102 `IkiWiki::RCS::svn`.
 103
 104 Each RCS plugin must support all the IkiWiki::rcs_* functions.
 105 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
 106 rcs_getctime does nothing except for throwing an error.