Photos
Blog
Projects
vanrenterghem.biz
projects
/
git.ikiwiki.info.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
indentation
[git.ikiwiki.info.git]
/
doc
/
plugins
/
listdirectives.mdwn
diff --git
a/doc/plugins/listdirectives.mdwn
b/doc/plugins/listdirectives.mdwn
index 3645813b880374c5279b7f66e27b3c77fab6a359..2d9bce01d383c24cb21f41320c8d930a0fd969ab 100644
(file)
--- a/
doc/plugins/listdirectives.mdwn
+++ b/
doc/plugins/listdirectives.mdwn
@@
-1,11
+1,15
@@
[[!template id=plugin name=listdirectives author="Will"]]
[[!tag type/meta]]
[[!template id=plugin name=listdirectives author="Will"]]
[[!tag type/meta]]
-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
.
+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
.