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 049833a8f81fa3ec5240ba3fa6e0f16e35a0a3cd..255f13f670c0701b97c504f4463a0b49be226b8b 100644 (file)
--- a/doc/plugins.mdwn
+++ b/doc/plugins.mdwn
@@ -1,4 +1,5 @@
-Most of ikiwiki's [[features]] are implemented as plugins.
+Most of ikiwiki's [[features]] are implemented as plugins. Many of these 
+plugins are included with ikiwiki.
 
 [[pagestats pages="plugins/type/* and !plugins/type/slow"]]
 
@@ -10,7 +11,15 @@ To enable plugins, use the `--plugin` switch described in
 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:
+
+    BEGIN { push @INC, "/home/user/.ikiwiki" } 
+
+
+## Plugin directory
 
 [[inline pages="plugins/* and !plugins/type/* and !plugins/write and
 !plugins/contrib and !*/Discussion"