summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/linkmap.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:27 +0200
committerJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:27 +0200
commit46d295eff558e247b05e61038bd82d5c5b8155a7 (patch)
tree13d82b647d5fb5e7f67ba4e7fde9f9206acce302 /ikiwiki/directive/linkmap.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
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..f89ee17
--- /dev/null
+++ b/ikiwiki/directive/linkmap.mdwn
@@ -0,0 +1,31 @@
+Die `linkmap`-Anweisung wird durch die [[!iki plugins/linkmap
+desc=linkmap]]-Erweiterung bereitgestellt.
+
+Diese Anweisung verwendet [graphviz](http://www.graphviz.org/), um einen
+Graph mit den Links zwischen den Seiten im Wiki zu erstellen. Beispiel:
+
+ \[[!linkmap pages="* and !blog/* and !*/Discussion"]]
+
+Nur Links zwischen den angegebenen Seiten werden angezeigt; Links die auf
+andere Seiten zeigen werden ausgelassen. Wenn die einzuschließenden Seiten
+nicht angegeben werden, werden Links zwischen allen Seiten (und anderen
+Dateien) im Wiki angezeigt.
+
+Hier die Beschreibung aller unterstützter Parameter der `linkmap`-Anweisung:
+
+* `pages` - Eine [[ikiwiki/PageSpec]] der darzustellenden Seiten.
+* `height`, `width` - Begrenzt die Größe der erzeugten Graphik auf die (in
+ Inch) angegebene Breite und Höne. Beide müssen angegeben werden, damit die
+ Beschränkung wirksam wird.
+* `connected` - Steuert ob auch Seiten dargestellt werden, die keinen Link
+ zu anderen Seiten enthalten (`connected=no`, die Voreinstellung), oder ob
+ nur Seiten angezeigt werden, die auf andere verlinken (`connected=yes`).
+
+Um die besten Ergebnisse zu erzielen, sollte nur eine kleine Teilmenge der
+Seiten angegeben werden, da die erzeugte Karte sonst groß, unhandlich und
+kompliziert wird. Wenn zu viele Seiten angegeben werden, kann die Karte zu
+kompliziert werden, als dass graphviz sie noch rendern könnte. Der Parameter
+`connected` ist ein guter Weg Seiten loszuwerden, die die Karte
+unübersichtlich machen.
+
+[[!meta robots="noindex, follow"]]