path: root/ikiwiki
diff options
authorzweistein <zweistein@web>2020-03-07 13:58:12 +0000
committerIkiWiki <>2020-03-07 13:58:12 +0000
commite5dad452328fa98af5faa127967077653b748b63 (patch)
tree6258c83b17ff9d28f19dae90b169cef97ecfed94 /ikiwiki
parent3f28c5ce26164d08eb3fc52da749e000f2ac5ccd (diff)
Diffstat (limited to 'ikiwiki')
1 files changed, 26 insertions, 0 deletions
diff --git a/ikiwiki/directive/map.mdwn b/ikiwiki/directive/map.mdwn
new file mode 100644
index 00000000..a187e6a0
--- /dev/null
+++ b/ikiwiki/directive/map.mdwn
@@ -0,0 +1,26 @@
+[[!if test="enabled(map)"
+ then="In diesem Wiki ist die Direktive: map **aktiviert**."
+ else="In diesem Wiki ist die Direktive: map **nicht aktiv**; falls dies gew├╝nscht wird, den Admin benachrichtigen."]]
+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"]]