updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / plugins / listdirectives.mdwn

diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn
index 0f33855f5eb2e56a4dba2189aebfefe4ceab3504..df854de52ecc78bd120e0f00606f2461608ff7b5 100644 (file)
--- a/doc/plugins/listdirectives.mdwn
+++ b/doc/plugins/listdirectives.mdwn
@@ -1,21 +1,16 @@
 [[!template id=plugin name=listdirectives author="Will"]]
 [[!tag type/meta]]
 [[!template id=plugin name=listdirectives author="Will"]]
 [[!tag type/meta]]

+[[!tag type/widget]]

 
 

-This plugin generates a list of available
-[[directives|ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/listdirectives]]
+[[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.
-
-There is one optional keyword argument, `generated`.  Normally the `listdirectives` directive will
-list all built in directives and directives directly registered by [[plugins]].  With this keyword,
-`listdirectives` will also list directives generated later.  For example, all [[shortcuts]] are
-directives generated in turn by the `shortcut` directive.  They will only be listed if the `generated` argument is
-supplied.
-
-    \[[!listdirectives generated]]
-
-This extended list is often quite long, and often contains many undocumented directives.
+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.