git.oblomov.eu Git - ikiwiki/blob - doc/plugins.mdwn

   1 Plugins can be used to add additional features to ikiwiki. Ikiwiki's
   2 backend RCS support is also pluggable, so support for new revision control
   3 systems can be added to ikiwiki. It's possible to [[write]] your own plugins,
   4 or you can install and use plugins contributed by others.
   5
   6 The ikiiki package includes some standard plugins that are installed and
   7 by default. These include [[inline]], [[pagecount]], and [[brokenlinks]].
   8 Of these, [[inline]] is enabled by default.
   9
  10 To enable other plugins, use the `--plugin` switch described in [[usage]],
  11 or the equivalent line in [[ikiwiki.setup]].
  12
  13 ## Plugin directory
  14
  15 Add your contributed plugins here.
  16
  17 [[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]
  18
  19 ## Installing third party plugins
  20
  21 Plugins are perl modules and should be installed somewhere in the perl
  22 module search path. See the @INC list at the end of the output of `perl -V`
  23 for a list of the directories in that path. All plugins are in the
  24 IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
  25 inside the perl search path. For example, if your perl looks in
  26 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
  27 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`