diff options
| author | http://www.cse.unsw.edu.au/~willu/ <http://www.cse.unsw.edu.au/~willu/@web> | 2008-08-27 22:28:59 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2008-08-27 22:28:59 -0400 |
| commit | da3501e15b6e6e261ecc44158fb904e413233ff0 (patch) | |
| tree | 1c144987d009d26904f25b6d486f59c6ea138480 | |
| parent | b21d4d60fbfd090d76e2d1937c4e16f4b5abf5ef (diff) | |
| download | ikiwiki-da3501e15b6e6e261ecc44158fb904e413233ff0.tar ikiwiki-da3501e15b6e6e261ecc44158fb904e413233ff0.tar.gz | |
Document the 'generated' keyword argument
| -rw-r--r-- | doc/plugins/listdirectives.mdwn | 10 |
1 files changed, 10 insertions, 0 deletions
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. |