X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/be56970d0565cc259bf28b1a3aa9582269c8d41f..48e004acb1cd8d09dfa52377bd48edaee293bc9f:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 57ec8afb9..45e380d58 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,19 +1,22 @@ -There's documentation if you want 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 ikiwiki package includes some standard plugins that are installed and -by default. These include [[inline]], [[pagecount]], [[brokenlinks]], -[[smiley]], and [[search]]. 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. +The [[mdwn]], [[inline]], and [[htmlscrubber]] plugins are enabled by default. To enable other plugins, use the `--plugin` switch described in [[usage]], -or the equivalent line in [[ikiwiki.setup]]. +or the equivalent `add_plugins` line in [[ikiwiki.setup]]. -## Plugin directory +# Plugin directory -Add your contributed plugins here. Or add ideas to the [[todo|todo/plugin]] page. +Add all plugins here. Or add ideas to the [[todo|todo/plugin]] page. -[[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"]] -## Installing third party plugins +# 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`