]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/listdirectives.mdwn
Merge commit 'upstream/master'
[git.ikiwiki.info.git] / doc / plugins / listdirectives.mdwn
index 7611389175218efdc9839b0ed4fda2e6348cf843..2d9bce01d383c24cb21f41320c8d930a0fd969ab 100644 (file)
@@ -1,9 +1,15 @@
 [[!template id=plugin name=listdirectives author="Will"]]
 [[!tag type/meta]]
 
 [[!template id=plugin name=listdirectives author="Will"]]
 [[!tag type/meta]]
 
-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.