X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins.mdwn;h=0bea3359237992fa1e3ddd57322e8f2986d6c74a;hb=f5379757860a88b4db0244d8b99c06a457798a42;hp=b107c359ea7089f15ba99d2f023a4544101de017;hpb=f8109304f3d57f7ed2913d80ae003baa1ef815ed;p=ikiwiki.git diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index b107c359e..0bea33592 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,27 +1,17 @@ -Plugins can be used to add additional features to ikiwiki. It's possible 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 ikiiki package includes some standard plugins that are installed and -by default. These include [[inline]], [[pagecount]], and [[brokenlinks]]. -Of these, [[inline]] is enabled by default. +[[!pagestats pages="plugins/type/* and !plugins/type/slow" among="plugins/*"]] -## Third party plugins +There's documentation if you want to [[write]] your own plugins, or you can +[[install]] plugins [[contributed|contrib]] by others. -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` - -Once a plugin is installed, you need to configure ikiwiki to load it using -the `--plugin` switch described in [[usage]], or the equivilant line in -[[ikiwiki.setup]]. +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. ## Plugin directory -Add your contributed plugins here. - -[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]] +[[!map pages="plugins/* and !plugins/type/* and !plugins/write and +!plugins/write/* and !plugins/contrib and !plugins/contrib/*/* and !plugins/install and !*/Discussion"]]