doc/plugins.mdwn

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