]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins.mdwn
web commit by ThomasSchwinge: Initial version.
[ikiwiki.git] / doc / plugins.mdwn
1 There's documentation if you want to [[write]] your own plugins, or you can install and use plugins contributed by others. 
2
3 The ikiwiki package includes some standard plugins that are installed and
4 by default. These include [[inline]], [[pagecount]], [[brokenlinks]],
5 [[smiley]], and [[search]]. Of these, [[inline]] is enabled by default.
6
7 To enable other plugins, use the `--plugin` switch described in [[usage]],
8 or the equivalent line in [[ikiwiki.setup]].
9
10 ## Plugin directory
11
12 Add your contributed plugins here. Or add ideas to the [[todo|todo/plugin]] page.
13
14 [[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]
15
16 ## Installing third party plugins
17
18 Plugins are perl modules and should be installed somewhere in the perl
19 module search path. See the @INC list at the end of the output of `perl -V`
20 for a list of the directories in that path. All plugins are in the
21 IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
22 inside the perl search path. For example, if your perl looks in
23 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
24 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`