X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/4a71047839469c56c838b54ce075ab67a58bacee..2bec3518c22c2627df4062c80179a5b7027c52bf:/doc/plugins.mdwn diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 6f4127e78..265833487 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,21 +1,23 @@ -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. Beyond the +[[type/core]] features, there are plugins to [[type/format]] text, +use [[type/tags]], show [[type/meta]] information, do other [[type/useful]] +stuff, add [[type/chrome]] to the wiki, or just have [[type/fun]]. -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. -To enable other plugins, use the `--plugin` switch described in [[usage]], or the equivilant line in -[[ikiwiki.setup]]. +The [[mdwn]], [[inline]], and [[htmlscrubber]] plugins are enabled by default. -## Plugin directory +To enable other plugins, use the `--plugin` switch described in [[usage]], +or the equivalent `add_plugins` line in [[ikiwiki.setup]]. -Add your contributed plugins here. +# Plugin directory -[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]] +Add all plugins here. Or add ideas to the [[todo|todo/plugin]] page. -## Installing third party plugins +[[inline pages="plugins/* and !plugins/type/* and !plugins/write and !plugins/contrib and !*/Discussion" archive="yes" rootpage="plugins/contrib"]] + +# 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` @@ -23,4 +25,4 @@ 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` \ No newline at end of file +plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`