listdirectives: Enable use of the directives underlay.
[ikiwiki.git] / doc / plugins / listdirectives.mdwn
index 3645813b880374c5279b7f66e27b3c77fab6a359..2939ff0ee17e42a70ff58fca726ef23c110f5046 100644 (file)
@@ -1,11 +1,15 @@
 [[!template id=plugin name=listdirectives author="Will"]]
 [[!tag type/meta]]
 
-This plugin generates a list of available
-[[directives|ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/linkmap]]
+[[ikiwiki/directive]], which inserts a list of currently available
+directives into the page.
 
-       \[[!listdirectives]]
+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".
 
-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.
+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.