X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ab071436fd2e5e56ecd31e098f17f8c1fd2ff4b9..cf5d4300f38120b0bcf79db0f2bf00fb29373a0e:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 915cc2a73..0bea33592 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,23 +1,17 @@ -There's documentation if you want to [[write]] your own plugins, or you can install and use plugins contributed by others. +Most of ikiwiki's [[features]] are implemented as plugins. Many of these +plugins are included with ikiwiki. -The ikiwiki package includes some standard plugins that are installed and -by default. These include [[inline]], [[pagecount]], and [[brokenlinks]], and [[search]]. Of these, [[inline]] is enabled by default. +[[!pagestats pages="plugins/type/* and !plugins/type/slow" among="plugins/*"]] -To enable other plugins, use the `--plugin` switch described in [[usage]], -or the equivalent line in [[ikiwiki.setup]]. +There's documentation if you want to [[write]] your own plugins, or you can +[[install]] plugins [[contributed|contrib]] by others. -## Plugin directory - -Add your contributed plugins here. +To enable a plugin, use the `--plugin` switch described in +[[usage]], or the equivalent `add_plugins` line in ikiwiki.setup. +Enable the [[goodstuff]] plugin to get a nice selection of plugins that +will fit most uses of ikiwiki. -[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]] - -## Installing third party plugins +## Plugin directory -Plugins are perl modules and should be installed somewhere in the perl -module search path. See the @INC list at the end of the output of `perl -V` -for a list of the directories in that path. All plugins are in the -IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory -inside the perl search path. For example, if your perl looks in -`/usr/local/lib/site_perl` for modules, you can locally install ikiwiki -plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin` +[[!map pages="plugins/* and !plugins/type/* and !plugins/write and +!plugins/write/* and !plugins/contrib and !plugins/contrib/*/* and !plugins/install and !*/Discussion"]]