From: http://www.cse.unsw.edu.au/~willu/ Date: Thu, 28 Aug 2008 02:28:59 +0000 (-0400) Subject: Document the 'generated' keyword argument X-Git-Tag: 2.62.1~1^2~7 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=da3501e15b6e6e261ecc44158fb904e413233ff0;p=ikiwiki.git Document the 'generated' keyword argument --- 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.