]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins.mdwn
Merge commit 'upstream/master' into pub/master
[git.ikiwiki.info.git] / doc / plugins.mdwn
index 86be637e65cb544d0aab801c4df0e119a9ff7348..527568208913e1c379c1ae31b79e2202173dab58 100644 (file)
@@ -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, 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]] plugins [[contributed|contrib]] by others.
 
 
-[[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib" show="60"]]
+To enable a plugin, 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/write/* and !plugins/contrib and !plugins/install and !*/Discussion"
+feedpages="created_after(plugins/graphviz)" archive="yes" sort=title
+rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]]