link updates
[ikiwiki.git] / doc / plugins / write.mdwn
index 04803f7778c9feb973203fb7838eeaf5aa1c672f..969862842a01eb07a97f877f705d2b5708af2f79 100644 (file)
@@ -17,8 +17,14 @@ being edited.
 
 ## 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 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.
+Plugins should, when imported, call IkiWiki::hook to hook into 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.
 
 ## Writing a [[PreProcessorDirective]]
 
@@ -26,7 +32,8 @@ 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.
+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. All parameters included in the directive are included
@@ -49,31 +56,54 @@ preprocessor time. Text output by a preprocessor directive will be passed throug
 
 ## Other types of hooks
 
-Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include:
+Beyond PreProcessorDirectives, Other types of hooks that can be used by
+plugins include:
 
 ### checkconfig
 
-        IkiWiki::hook(type => "delete", id => "foo", call => \&checkconfig);
+       IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
 
-This is useful if the plugin needs to check for, or modify ikiwiki's configuration. It's called early in the ikiwiki startup process. It's ok for
-the function to call IkiWiki::error if something isn't configured right.
+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.
+
+### filter
+
+       IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
+
+Runs on the raw source of a page, before anything else touches it, and can
+make arbitrary changes. The function is passed named parameters `page` and
+`content` should return the filtered content.
 
 ### delete
 
-        IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
+       IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
 
-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.
+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.
 
 ### render
 
-        IkiWiki::hook(type => "render", id => "foo", call => \&render);
+       IkiWiki::hook(type => "render", id => "foo", call => \&render);
+
+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.
+
+### cgi
+
+       IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
 
-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.
+Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
+called in turn, and passed a CGI object. The hook should examine the
+parameters, and if it will handle this CGI request, output a page and
+terminate the program.
 
 ## 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
+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
@@ -96,12 +126,26 @@ use the following hashes, using a page name as the key:
   it is by using the IkiWiki::add_depends function, which takes as its
   parameters the page name and a [[GlobList]] of dependencies to add.
 
+## Page templates
+
+Plugins are mostly limited to changing the content of pages, to change the
+look and feel of the wiki it's generally better to use a stylesheet and
+[[templates]]. However, there are some hooks in the templates that plugins
+can use to add stuff to the wiki's UI:
+
+### Adding content to the page header
+
+Html that is added to $IkiWiki::config{headercontent} will show up in the
+header of the page. One good thing to put here is a search form.
+
 ## RCS plugins
 
 ikiwiki's support for revision control systems also uses pluggable perl
 modules. These are in the `IkiWiki::RCS` namespace, for example
 `IkiWiki::RCS::svn`. 
 
-Each RCS plugin must support all the IkiWiki::rcs_* functions.
+Each RCS plugin must support all the IkiWiki::rcs\_* functions.
 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
-rcs_getctime does nothing except for throwing an error.
+rcs\_getctime does nothing except for throwing an error.
+
+See [[about_RCS_backends]] for some more info.