X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/54d5308cd83c67e7e9c32450c776ef0dac63549f..dc52eb68a8e493440a3938f31d7bcb876005e5fb:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index e83250f02..45e380d58 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,12 +1,22 @@ -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, 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 by others. -## Third party plugins +The [[mdwn]], [[inline]], and [[htmlscrubber]] 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 all plugins here. Or add ideas to the [[todo|todo/plugin]] page. + +[[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib"]] + +# 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` @@ -15,13 +25,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` - -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]]. - -## Plugin directory - -Add your contributed plugins using this form: - -[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]