Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / plugins / listdirectives.mdwn
1 [[!template id=plugin name=listdirectives author="Will"]]
2 [[!tag type/meta]]
3
4 This plugin generates a list of available
5 [[directives|ikiwiki/directive]].
6
7         \[[!listdirectives]]
8
9 Each directive links to a wiki page with the same name. The location of the
10 pages in the wiki can be controlled via the `directive_description_dir`
11 setting in the setup file.
12
13 There is one optional keyword argument, `generated`.  Normally the `listdirectives` directive will
14 list all built in directives and directives directly registered by [[plugins]].  With this keyword,
15 `listdirectives` will also list directives generated later.  For example, all [[shortcuts]] are
16 directives generated in turn by the `shortcut` directive.  They will only be listed if the `generated` argument is
17 supplied.
18
19     \[[!listdirectives generated]]
20
21 This extended list is often quite long, and often contains many undocumented directives.