X-Git-Url: https://scripts.mit.edu/gitweb/www/ikiwiki.git/blobdiff_plain/95274e6bd60acbdc9dbd7be31d50b98e7ba1727a..57d12405ae474d27c63dc33ee5fa642a2c5d7461:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index ae9c6300a..ec7ee5914 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,15 +1,20 @@ -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. +Plugins can be used to add additional features to ikiwiki. The interface is quite flexible, allowing plugins to register [[PreProcessorDirective]]s, hook into [[CGI]] mode, and more. Ikiwiki's backend RCS support is also pluggable, so support for new revision control systems can be added to 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. +There's documentation if you want to [[write]] your own plugins, or you can install and use plugins contributed by others. -To enable other plugins, use the `--plugin` switch described in [[usage]], or the equivilant line in -[[ikiwiki.setup]]. +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. -## Third party plugins +To enable other plugins, use the `--plugin` switch described in [[usage]], +or the equivalent line in [[ikiwiki.setup]]. + +## Plugin directory + +Add your contributed plugins here. + +[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]] + +## Installing third party plugins 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` @@ -18,10 +23,3 @@ 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` - - -## Plugin directory - -Add your contributed plugins here. - -[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]