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.mdwn25
1 files changed, 25 insertions, 0 deletions
diff --git a/ikiwiki/directive/map.mdwn b/ikiwiki/directive/map.mdwn
new file mode 100644
index 0000000..f8ef0e6
--- /dev/null
+++ b/ikiwiki/directive/map.mdwn
@@ -0,0 +1,25 @@
+La directive `map` est fournie par le module d'extension [[!iki plugins/map
+desc=map]].
+
+Cette directive crée une représentation hiérarchisée des pages du
+wiki. Voici un exemple d'utilisation :
+
+ \[[!map pages="* and !blog/* and !*/Discussion"]]
+
+Si les pages à inclure ne sont pas spécifiées, toutes les pages (et tous les
+fichiers) sont pris en compte.
+
+Par défaut, les noms des pages sont utilisés dans la représentation. Le
+paramètre `show` permet d'utiliser à la place le titre des pages ou leur
+description lorsqu'ils ont été définis avec la directive [[meta]]. Par
+exemple :
+
+ \[[!map pages="* and !blog/* and !*/Discussion" show=title]]
+
+ \[[!map pages="* and !blog/* and !*/Discussion" show=description]]
+
+Pour n'afficher les pages que jusqu'à un certain niveau de profondeur, vous
+pouvez utiliser une spécification [[ikiwiki/PageSpec]] comme celle-ci :
+`pages=\"* and !*/*/*\"`.
+
+[[!meta robots="noindex, follow"]]