X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c69a7f758590c91bd137a8d1cfa99f37bf28045a..2cab8880ad61f9d134b56c5eed952c1a48f4ea8a:/doc/plugins/listdirectives.mdwn diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn index 761138917..df854de52 100644 --- a/doc/plugins/listdirectives.mdwn +++ b/doc/plugins/listdirectives.mdwn @@ -1,9 +1,16 @@ [[!template id=plugin name=listdirectives author="Will"]] [[!tag type/meta]] +[[!tag type/widget]] -This plugin implements the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]]. -The linkmap directive inserts a list of currently available directives into the page. +This plugin provides the [[ikiwiki/directive/listdirectives]] +[[ikiwiki/directive]], which inserts a list of currently available +directives into the page. -Each directive links to a wiki page with the same name. The location of the -pages in the wiki can be controlled via the `directive_description_dir` -setting in the setup file. +Each directive links to a wiki page with the same name, that should +document that directive. The location of these pages can be controlled via +the `directive_description_dir` setting in the setup file, the default is +"ikiwiki/directive/foo". + +When this plugin is enabled, it enables the directives underlay, which +contains documentation about all the directives included in plugins shipped +with ikiwiki. This adds about 200 kb to the size of your wiki.