]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins.mdwn
Merge commit 'origin/master' into pub/master
[git.ikiwiki.info.git] / doc / plugins.mdwn
index e83250f022cb5cb8813099c190cc650775643866..527568208913e1c379c1ae31b79e2202173dab58 100644 (file)
@@ -1,27 +1,19 @@
-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. 
+Most of ikiwiki's [[features]] are implemented as plugins. Many of these 
+plugins are included with 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.
+[[!pagestats pages="plugins/type/* and !plugins/type/slow"]]
 
-## Third party plugins
+There's documentation if you want to [[write]] your own plugins, or you can
+[[install]] plugins [[contributed|contrib]] by others.
 
-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`
-
-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]].
+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.
 
 ## Plugin directory
 
-Add your contributed plugins using this form:
-
-[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]
+[[!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]]