X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..a9d2fe65ac86eda8c821c96a4454a354e961c86f:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 6de17adc7..3f154f1f0 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,28 +1,19 @@ -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]]. +Most of ikiwiki's [[features]] are implemented as plugins. Many of these +plugins are included with ikiwiki. -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 `add_plugins` line in [[ikiwiki.setup]]. +[[pagestats pages="plugins/type/* and !plugins/type/slow"]] -# Plugin directory - -Add all plugins here. Or add ideas to the [[todo|todo/plugin]] page. +There's documentation if you want to [[write]] your own plugins, or you can +install and use plugins [[contributed|contrib]] by others. -[[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib"]] +To enable plugins, use the `--plugin` switch described in +[[usage]], or the equivalent `add_plugins` line in [[ikiwiki.setup]]. +Enable the [[goodstuff]] plugin to get a nice selection of plugins that +will fit most uses of ikiwiki. -# Installing third party plugins +## Plugin directory -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" +feedpages="created_after(plugins/graphviz)" archive="yes" +rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]]