]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins.mdwn
web commit by http://harningt.myopenid.com/: IRC discussion about usage semantics
[git.ikiwiki.info.git] / doc / plugins.mdwn
index e2f0492af0bd60f96f887beecaa116cda82d0f8f..439cecc8aff3d1efdb0fe6dfefc9fffae2882fea 100644 (file)
@@ -1,25 +1,19 @@
-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. Many of these 
+plugins are included with ikiwiki.
 
 
-The ikiwiki package includes some standard plugins that are installed and
-by default. These include [[inline]], [[htmlscrubber]], [[pagecount]],
-[[brokenlinks]], [[search]], [[smiley]], and even [[haiku]]. 
-Of these, [[inline]] and [[htmlscrubber]] are enabled by default.
+[[pagestats pages="plugins/type/* and !plugins/type/slow"]]
 
 
-To enable other plugins, use the `--plugin` switch described in [[usage]],
-or the equivalent line in [[ikiwiki.setup]].
+There's documentation if you want to [[write]] your own plugins, or you can
+[[install]] plugins [[contributed|contrib]] by others.
 
 
-## Plugin directory
-
-Add your contributed plugins here. Or add ideas to the [[todo|todo/plugin]] page.
+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.
 
 
-[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]
-
-## 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"
+rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]]