diff options
| author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
| commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
| tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/listdirectives.mdwn | |
| parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) | |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/listdirectives.mdwn')
| -rw-r--r-- | doc/plugins/listdirectives.mdwn | 16 |
1 files changed, 2 insertions, 14 deletions
diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn index 0f33855f5..761138917 100644 --- a/doc/plugins/listdirectives.mdwn +++ b/doc/plugins/listdirectives.mdwn @@ -1,21 +1,9 @@ [[!template id=plugin name=listdirectives author="Will"]] [[!tag type/meta]] -This plugin generates a list of available -[[directives|ikiwiki/directive]]. - - \[[!listdirectives]] +This plugin implements the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]]. +The linkmap directive inserts a list of currently available directives into the page. 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. |