X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/54d5308cd83c67e7e9c32450c776ef0dac63549f..72dbbe3a2cc3550a2aaaf226fd561c0d5064b5b4:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index e83250f02..46527ce4f 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. 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]]. -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|contrib]] by others. -## 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` - -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 +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]]. -## Plugin directory - -Add your contributed plugins using this form: +# Plugin directory -[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]] +[[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib"]]