]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins.mdwn
web commit by NicolasLimare: how to use plugins from $HOME
[ikiwiki.git] / doc / plugins.mdwn
1 Most of ikiwiki's [[features]] are implemented as plugins. Many of these 
2 plugins are included with ikiwiki.
3
4 [[pagestats pages="plugins/type/* and !plugins/type/slow"]]
5
6 There's documentation if you want to [[write]] your own plugins, or you can
7 install and use plugins [[contributed|contrib]] by others.
8
9 To enable plugins, use the `--plugin` switch described in
10 [[usage]], or the equivalent `add_plugins` line in [[ikiwiki.setup]].
11 Enable the [[goodstuff]] plugin to get a nice selection of plugins that
12 will fit most uses of ikiwiki.
13
14 Without administrator access, you can add some custom plugins by storing 
15 yourcustomplugin.pm in /home/user/.ikiwiki/IkiWiki/Plugins (or any other
16 place, keeping the "IkiWiki/Plugins" part of the path) and adding this
17 line at the begining of your ikiwiki.setup file:
18
19     BEGIN { push @INC, "/home/user/.ikiwiki" } 
20
21
22 ## Plugin directory
23
24 [[inline pages="plugins/* and !plugins/type/* and !plugins/write and
25 !plugins/contrib and !*/Discussion"
26 feedpages="created_after(plugins/graphviz)" archive="yes"
27 rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]]