X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/57d12405ae474d27c63dc33ee5fa642a2c5d7461..f8cbf79735bc4588ba6fde12f3855a51efeb7ae8:/doc/plugins.mdwn?ds=sidebyside diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index ec7ee5914..46527ce4f 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,25 +1,17 @@ -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. +Most of ikiwiki's [[features]] are implemented as plugins. Beyond the +[[type/core]] features, there are plugins to [[type/format]] text, +use [[type/tags]], show [[type/meta]] information, add [[type/auth]] +methods, do other [[type/useful]] stuff, add [[type/chrome]] to the +wiki, or just have [[type/fun]]. -There's documentation if you want to [[write]] your own plugins, or you can install and use plugins contributed by others. +There's documentation if you want to [[write]] your own plugins, or you can +install and use plugins [[contributed|contrib]] by others. -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. +The [[mdwn]], [[inline]], [[htmlscrubber]], and [[passwordauth]] plugins +are enabled by default. To enable other plugins, use the `--plugin` switch +described in [[usage]], or the equivalent `add_plugins` line in +[[ikiwiki.setup]]. -To enable other plugins, use the `--plugin` switch described in [[usage]], -or the equivalent line in [[ikiwiki.setup]]. +# Plugin directory -## 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` -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` +[[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib"]]