web commit by NicolasLimare: how to use plugins from $HOME

[ikiwiki.git] / doc / plugins.mdwn

diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn
index ec7ee59147023435a5b1d5c4f83d818bac9c2a0a..255f13f670c0701b97c504f4463a0b49be226b8b 100644 (file)
--- a/doc/plugins.mdwn
+++ b/doc/plugins.mdwn
@@ -1,25 +1,27 @@
-Plugins can be used to add additional features to ikiwiki. The interface is quite flexible, allowing plugins to register [[PreProcessorDirective]]s, hook into [[CGI]] mode, and more. Ikiwiki's backend RCS support is also pluggable, so support for new revision control systems can be added to ikiwiki. 
+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. 
+[[pagestats pages="plugins/type/* and !plugins/type/slow"]]
 
-The ikiwiki package includes some standard plugins that are installed and
-by default. These include [[inline]], [[pagecount]], and [[brokenlinks]], 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|contrib]] by others.
 
-To enable other plugins, use the `--plugin` switch described in [[usage]],
-or the equivalent line in [[ikiwiki.setup]].
+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.
 
-## Plugin directory
+Without administrator access, you can add some custom plugins by storing 
+yourcustomplugin.pm in /home/user/.ikiwiki/IkiWiki/Plugins (or any other
+place, keeping the "IkiWiki/Plugins" part of the path) and adding this
+line at the begining of your ikiwiki.setup file:
 
-Add your contributed plugins here.
+    BEGIN { push @INC, "/home/user/.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/contrib and !*/Discussion"
+feedpages="created_after(plugins/graphviz)" archive="yes"
+rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]]