`IkiWiki::Plugin::skeleton` that can be fleshed out to make a useful
plugin. `IkiWiki::Plugin::pagecount` is another simple example.
-# Note
+[[toc levels=2]]
+
+## Considerations
One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
*compiler*. So plugins influence pages when they are built, not when they
change until ikiwiki rebuilds the page for some other reason, like the page
being edited.
-# Registering plugins
+## Registering plugins
Plugins should, when imported, call IkiWiki::hook to hook into ikiwiki's
processing. The function uses named parameters, and use varies depending on
a "call" parameter, which is a reference to a function to call for the
hook.
-# Types of hooks
+## Types of hooks
In roughly the order they are called.
-## getopt
+### getopt
IkiWiki::hook(type => "getopt", id => "foo", call => \&getopt);
an option it cannot process, and should just skip over those options and
leave them in @ARGV.
-## checkconfig
+### checkconfig
IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
function is passed no values. It's ok for the function to call
IkiWiki::error if something isn't configured right.
-## filter
+### filter
IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
make arbitrary changes. The function is passed named parameters `page` and
`content` and should return the filtered content.
-## preprocess
+### preprocess
Adding a [[PreProcessorDirective]] is probably the most common use of a
plugin.
linkified and passed through markdown (or whatever engine is used to htmlize
the page) along with the rest of the page.
-## htmlize
+### htmlize
IkiWiki::hook(type => "htmlize", id => "ext", call => \&htmlize);
this plugin. This is how you can add support for new and exciting markup
languages to ikiwiki.
-## pagetemplate
+The function is passed named parameters: "page" and "content" and should
+return the htmlized content.
+
+### pagetemplate
IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
The most common thing to do is probably to call $template->param() to add
a new custom parameter to the template.
-## sanitize
+### sanitize
IkiWiki::hook(type => "sanitize", id => "foo", call => \&sanitize);
Use this to implement html sanitization or anything else that needs to
modify the body of a page after it has been fully converted to html.
-The function is passed the page content and should return the sanitized
-content.
-## format
+The function is passed named parameters: "page" and "content", and
+should return the sanitized content.
+
+### format
IkiWiki::hook(type => "format", id => "foo", call => \&format);
-The function is passed the complete page content and can reformat it
-and return the new content. The difference between format and sanitize is
-that sanitize only acts on the page body, while format can modify the
-entire html page including the header and footer inserted by ikiwiki, the
-html document type, etc.
+The difference between format and sanitize is that sanitize only acts on
+the page body, while format can modify the entire html page including the
+header and footer inserted by ikiwiki, the html document type, etc.
+
+The function is passed named parameters: "page" and "content", and
+should return the formatted content.
-## delete
+### delete
IkiWiki::hook(type => "delete", id => "foo", call => \&delete);
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.
-## change
+### change
IkiWiki::hook(type => "change", id => "foo", call => \&render);
wiki, the referenced function is called, and passed the names of the
source files that were rendered.
-## cgi
+### cgi
IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
parameters, and if it will handle this CGI request, output a page and
terminate the program.
-## savestate
+### savestate
IkiWiki::hook(type => "savestate", id => "foo", call => \&savestate);
## Error handing
-While a plugin can call ikiwiki's error routine for a fatal error, for
+While a plugin can call ikiwiki's `error` routine for a fatal error, for
errors that aren't intended to halt the entire wiki build, including bad
parameters passed to a [[PreProcessorDirective]], etc, it's better to just
return the error message as the output of the plugin.
-# Wiki configuration
+## Wiki configuration
A plugin can access the wiki's configuration via the `%IkiWiki::config`
hash. The best way to understand the contents of the hash is to look at
[[ikiwiki.setup]], which sets the hash content to configure the wiki.
-# Wiki data
+## Wiki data
If your plugin needs to access data about other pages in the wiki. It can
use the following hashes, using a page name as the key:
* `%IkiWiki::forcerebuild` any pages set as the keys to this hash will be
treated as if they're modified and rebuilt.
-# A note on generating html links
+## Generating html links
Many plugins need to generate html links and add them to a page. This is
done by using the `IkiWiki::htmllink` function. The usual way to call
of the hook functions above; the ones that are not passed it are not used
during inlining and don't need to worry about this issue.
-# RCS plugins
+## RCS plugins
ikiwiki's support for revision control systems also uses pluggable perl
modules. These are in the `IkiWiki::RCS` namespace, for example