X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/da3501e15b6e6e261ecc44158fb904e413233ff0..34076e398cb7662e3bf0659d591faa4208679882:/doc/plugins/listdirectives.mdwn?ds=sidebyside diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn index 0f33855f5..df854de52 100644 --- a/doc/plugins/listdirectives.mdwn +++ b/doc/plugins/listdirectives.mdwn @@ -1,21 +1,16 @@ [[!template id=plugin name=listdirectives author="Will"]] [[!tag type/meta]] +[[!tag type/widget]] -This plugin generates a list of available -[[directives|ikiwiki/directive]]. +This plugin provides the [[ikiwiki/directive/listdirectives]] +[[ikiwiki/directive]], which inserts a list of currently available +directives into the page. - \[[!listdirectives]] +Each directive links to a wiki page with the same name, that should +document that directive. The location of these pages can be controlled via +the `directive_description_dir` setting in the setup file, the default is +"ikiwiki/directive/foo". -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. +When this plugin is enabled, it enables the directives underlay, which +contains documentation about all the directives included in plugins shipped +with ikiwiki. This adds about 200 kb to the size of your wiki.