summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/linkmap.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/linkmap.mdwn')
-rw-r--r--ikiwiki/directive/linkmap.mdwn31
1 files changed, 31 insertions, 0 deletions
diff --git a/ikiwiki/directive/linkmap.mdwn b/ikiwiki/directive/linkmap.mdwn
new file mode 100644
index 0000000..cc5e369
--- /dev/null
+++ b/ikiwiki/directive/linkmap.mdwn
@@ -0,0 +1,31 @@
+"La directive `linkmap` est fournie par le module d'extension [[!iki
+plugins/linkmap desc=linkmap]].
+
+Cette directive utilise le programme [graphviz](http://www.graphviz.org/)
+pour créer un graphique montrant les liens existants entre certaines pages
+du wiki. Par exemple :
+
+ \[[!linkmap pages="* and !blog/* and !*/Discussion"]]
+
+Seuls les liens entre les pages recherchées sont montrés. Des liens
+existants entre des pages non recherchées sont ignorés. Si les pages à
+rechercher ne sont pas spécifiées, les liens entre toutes les pages (et tous
+les fichiers) du wiki seront affichés.
+
+Voici la description des paramètres de la directive `linkmap` :
+
+* `pages` - Une spécification [[ikiwiki/PageSpec]] des pages à rechercher.
+* `height`, `width` - Ces paramètres limitent la taille du diagramme, avec
+ une hauteur et une largeur exprimées en pouce. Vous devez les indiquer
+ tous les deux. Sinon le programme choisira une valeur sans limites.
+* `connected` - permet d'indiquer si l'on inclut les pages sans lien à
+ d'autres pages (connected=no, par défaut), ou si l'on ne montre que les
+ pages liées à d'autres pages (connected=yes).
+
+Pour des résultats corrects, il vaut mieux définir l'ensemble des pages à
+rechercher. Sinon, le diagramme deviendra très grand, illisible et
+compliqué. Si l'on inclut trop de pages, le diagramme deviendra si grand que
+graphviz ne pourra pas l'afficher. Le paramètre `connected` permet de se
+débarrasser des pages qui encombrent le diagramme.
+
+[[!meta robots="noindex, follow"]]