a "call" parameter, which is a reference to a function to call for the
hook.
-# Writing a [[PreProcessorDirective]]
+# Types of hooks
-This is probably the most common use of a plugin.
-
- IkiWiki::hook(type => "preprocess", id => "foo", call => \&preprocess);
-
-Replace "foo" with the command name that will be used inside brackers for
-the preprocessor directive.
-
-Each time the directive is processed, the referenced function (`preprocess`
-in the example above) is called, and is passed named parameters. A "page"
-parameter gives the name of the page that embedded the preprocessor
-directive, while a "destpage" parameter gices the name of the page the
-content is going to (different for inlined pages). All parameters included
-in the directive are included as named parameters as well. Whatever the
-function returns goes onto the page in place of the directive.
-
-## Error handing
-
-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.
-
-## Html issues
-
-Note that if the [[htmlscrubber]] is enabled, html in
-[[PreProcessorDirective]] output is sanitised, which may limit what your
-plugin can do. Also, the rest of the page content is not in html format at
-preprocessor time. Text output by a preprocessor directive will be passed
-through markdown (or whatever engine is used to htmlize the page) along
-with the rest of the page.
-
-# Other types of hooks
-
-Beyond PreProcessorDirectives, Other types of hooks that can be used by
-plugins include:
+In roughly the order they are called.
## getopt
make arbitrary changes. The function is passed named parameters `page` and
`content` and should return the filtered content.
+## preprocess
+
+Adding a [[PreProcessorDirective]] is probably the most common use of a
+plugin.
+
+ IkiWiki::hook(type => "preprocess", id => "foo", call => \&preprocess);
+
+Replace "foo" with the command name that will be used inside brackets for
+the preprocessor directive.
+
+Each time the directive is processed, the referenced function (`preprocess`
+in the example above) is called, and is passed named parameters. A "page"
+parameter gives the name of the page that embedded the preprocessor
+directive, while a "destpage" parameter gices the name of the page the
+content is going to (different for inlined pages). All parameters included
+in the directive are included as named parameters as well. Whatever the
+function returns goes onto the page in place of the directive.
+
+Note that if the [[htmlscrubber]] is enabled, html in
+[[PreProcessorDirective]] output is sanitised, which may limit what your
+plugin can do. Also, the rest of the page content is not in html format at
+preprocessor time. Text output by a preprocessor directive will be
+linkified and passed through markdown (or whatever engine is used to htmlize
+the page) along with the rest of the page.
+
## 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.
+The function is passed named parameters: "page" and "content" and should
+return the htmlized content.
+
## pagetemplate
IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
object.
The most common thing to do is probably to call $template->param() to add
-a new custom parameter to the template. Note that in order to be robust,
-it's a good idea to check whether the template has a variable before trying
-to set it, as setting a variable that's not present is an error.
-
- if ($template->query(name => 'foo')) {
- $template->param("foo" => "bar");
- }
+a new custom parameter to the template.
## 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.
+
+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
the state is saved. The function can save other state, modify values before
they're saved, etc.
+## Error handing
+
+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
A plugin can access the wiki's configuration via the `%IkiWiki::config`
sipb-www / ikiwiki.git / blobdiff