From da3501e15b6e6e261ecc44158fb904e413233ff0 Mon Sep 17 00:00:00 2001 From: "http://www.cse.unsw.edu.au/~willu/" Date: Wed, 27 Aug 2008 22:28:59 -0400 Subject: [PATCH] Document the 'generated' keyword argument --- doc/plugins/listdirectives.mdwn | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn index 3645813b8..0f33855f5 100644 --- a/doc/plugins/listdirectives.mdwn +++ b/doc/plugins/listdirectives.mdwn @@ -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. -- 2.26.2