summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/map.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/map.mdwn')
-rw-r--r--ikiwiki/directive/map.mdwn24
1 files changed, 24 insertions, 0 deletions
diff --git a/ikiwiki/directive/map.mdwn b/ikiwiki/directive/map.mdwn
new file mode 100644
index 0000000..07ded45
--- /dev/null
+++ b/ikiwiki/directive/map.mdwn
@@ -0,0 +1,24 @@
+Die `map`-Anweisung wird durch die [[!iki plugins/map desc=map]]-Erweiterung
+bereitgestellt.
+
+Diese Anweisung erzeugt eine hierarchische Liste der Seiten im
+Wiki. Beispiel für die Verwendung:
+
+ \[[!map pages="* and !blog/* and !*/Discussion"]]
+
+Wenn die anzuzeigenden Seiten nicht angegeben werden, kommen alle Seiten
+(und andere Dateien) in die Liste.
+
+In der Voreinstellung werden in der Liste die Namen der Seiten
+angezeigt. Mit dem Parameter `show` können stattdessen der Titel (`title`)
+oder die Beschreibung (`description`) verwendet werden, die mit der
+[[meta]]-Anweisung gesetzt wurden. Zum Beispiel:
+
+ \[[!map pages="* and !blog/* and !*/Discussion" show=title]]
+
+ \[[!map pages="* and !blog/* and !*/Discussion" show=description]]
+
+Tipp: Um nur Seiten bis zu einer bestimmten Ebene anzuzeigen, kann eine
+[[ikiwiki/PageSpec]] wie `pages="* and !*/*/*"` verwendet werden.
+
+[[!meta robots="noindex, follow"]]