cd6037c2b442aabf6519cd066a164f766f1af205
[ikiwiki.git] / doc / plugins.mdwn
1 Most of ikiwiki's [[features]] are implemented as plugins. Beyond the
2 [[type/core]] features, there are plugins to [[type/format]] text,
3 use [[type/tags]], show [[type/meta]] information, add [[type/auth]]
4 methods, do other [[type/useful]] stuff, add [[type/chrome]] to the
5 wiki, or just have [[type/fun]].
6
7 There's documentation if you want to [[write]] your own plugins, or you can
8 install and use plugins contributed by others. 
9
10 The [[mdwn]], [[inline]], [[htmlscrubber]], and [[passwordauth]] plugins
11 are enabled by default. To enable other plugins, use the `--plugin` switch
12 described in [[usage]], or the equivalent `add_plugins` line in
13 [[ikiwiki.setup]].
14
15 # Plugin directory
16
17 Add all plugins here. Or add ideas to the [[todo|todo/plugin]] page.
18
19 [[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib"]]
20
21 # Installing third party plugins
22
23 Plugins are perl modules and should be installed somewhere in the perl
24 module search path. See the @INC list at the end of the output of `perl -V`
25 for a list of the directories in that path. All plugins are in the
26 IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
27 inside the perl search path. For example, if your perl looks in
28 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
29 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`