path: root/ikiwiki/directive/map.mdwn
diff options
Diffstat (limited to 'ikiwiki/directive/map.mdwn')
1 files changed, 21 insertions, 0 deletions
diff --git a/ikiwiki/directive/map.mdwn b/ikiwiki/directive/map.mdwn
new file mode 100644
index 0000000..4b64995
--- /dev/null
+++ b/ikiwiki/directive/map.mdwn
@@ -0,0 +1,21 @@
+The `map` directive is supplied by the [[!iki plugins/map desc=map]] plugin.
+This directive generates a hierarchical page map for the wiki. Example usage:
+ \[[!map pages="* and !blog/* and !*/Discussion"]]
+If the pages to include are not specified, all pages (and other files) in
+the wiki are mapped.
+By default, the names of pages are shown in the map. The `show` parameter
+can be used to show the titles or descriptions of pages instead (as set by
+the [[meta]] directive). For example:
+ \[[!map pages="* and !blog/* and !*/Discussion" show=title]]
+ \[[!map pages="* and !blog/* and !*/Discussion" show=description]]
+Hint: To limit the map to displaying pages less than a certain level deep,
+use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
+[[!meta robots="noindex, follow"]]