summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/listdirectives.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
commit9921a4a8a1a696ce69acce5e14943f0149d926ff (patch)
tree926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/listdirectives.mdwn
parent7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff)
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/listdirectives.mdwn')
-rw-r--r--doc/ikiwiki/directive/listdirectives.mdwn20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/listdirectives.mdwn b/doc/ikiwiki/directive/listdirectives.mdwn
new file mode 100644
index 000000000..0564159e0
--- /dev/null
+++ b/doc/ikiwiki/directive/listdirectives.mdwn
@@ -0,0 +1,20 @@
+The `listdirectives` directive is supplied by the [[!iki plugins/listdirectives]] plugin.
+
+This directive generates a list of available
+[[directives|ikiwiki/directive]].
+
+ \[[!listdirectives]]
+
+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.
+
+[[!meta robots="noindex, follow"]]