Document the 'generated' keyword argument
[ikiwiki.git] / doc / plugins / listdirectives.mdwn
index 3645813b880374c5279b7f66e27b3c77fab6a359..0f33855f5eb2e56a4dba2189aebfefe4ceab3504 100644 (file)
@@ -9,3 +9,13 @@ This plugin generates a list of available
 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.