]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins.mdwn
web commit by joey
[ikiwiki.git] / doc / plugins.mdwn
index e83250f022cb5cb8813099c190cc650775643866..ec7ee59147023435a5b1d5c4f83d818bac9c2a0a 100644 (file)
@@ -1,12 +1,20 @@
-Plugins can be used to add additional features to ikiwiki. It's possible to
-[[write]] your own plugins, or you can install and use plugins contributed by
-others. 
+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. 
 
-The ikiiki package includes some standard plugins that are installed and
-by default. These include [[inline]], [[pagecount]], and [[brokenlinks]].
-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 by others. 
 
-## Third party plugins
+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.
+
+To enable other plugins, use the `--plugin` switch described in [[usage]],
+or the equivalent line in [[ikiwiki.setup]].
+
+## Plugin directory
+
+Add your contributed plugins here.
+
+[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]
+
+## Installing third party plugins
 
 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`
@@ -15,13 +23,3 @@ 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`
-
-Once a plugin is installed, you need to configure ikiwiki to load it using
-the `--plugin` switch described in [[usage]], or the equivilant line in
-[[ikiwiki.setup]].
-
-## Plugin directory
-
-Add your contributed plugins using this form:
-
-[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]