From 75a11e6a8d92f7ff221eb4b1270526d57ef537bc Mon Sep 17 00:00:00 2001 From: joey Date: Mon, 13 Aug 2007 17:22:15 +0000 Subject: improved docs, add a tutorial for writing plugins --- doc/plugins/install.mdwn | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 doc/plugins/install.mdwn (limited to 'doc/plugins/install.mdwn') diff --git a/doc/plugins/install.mdwn b/doc/plugins/install.mdwn new file mode 100644 index 000000000..aa1c932bc --- /dev/null +++ b/doc/plugins/install.mdwn @@ -0,0 +1,19 @@ +[[meta title="Installing third party plugins"]] + +Most ikiwiki plugins are perl modules and should be installed somewhere in +the perl module search path. See the @INC list at the end of the output of +`perl -V` for a list of the directories in that path. All plugins are in +the IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory +inside the perl search path. For example, if your perl looks in +`/usr/local/lib/site_perl` for modules, you can locally install ikiwiki +plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin` + +You can use the `libdir` configuration option to add a directory to the +search path. For example, if you set `libdir` to `/home/you/.ikiwiki/`, +then ikiwiki will look for plugins in `/home/you/.ikiwiki/IkiWiki/Plugins`. + +Ikiwiki also supports plugins that are external programs. These are +typically written in some other language than perl. Ikiwiki searches for +these in `/usr/lib/ikiwiki/plugins` by default. If `libdir` is set, it will +also look under that directory, for example in `/home/you/.ikiwiki/plugins`. +Note that this type of plugin has to be executable for ikiwiki to use it. -- cgit v1.2.3