web commit by http://joey.kitenet.net/

[git.ikiwiki.info.git] / doc / plugins / linkmap.mdwn

diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
index 35dcf8f56e82f6e641fc3285842717aca91525a1..e0eda92893a53a616f96a673666611525df38ab4 100644 (file)
--- a/doc/plugins/linkmap.mdwn
+++ b/doc/plugins/linkmap.mdwn
@@ -1,8 +1,7 @@
 [[template id=plugin name=linkmap included=1 author="Joey Hess"]]
 [[tag type/meta]]
 [[tag type/slow]]
-the mapped pages is changed, which can make the wiki a bit slow.
-This plugin uses graphviz to generate a graph showing the links between a
+This plugin uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a
 set of pages in the wiki. Example usage:
 
        \[[linkmap pages="* and !blog/* and !*/Discussion"]]
@@ -15,6 +14,14 @@ the map can become very large, unweildy, and complicated. Also, the map is
 rebuilt whenever one of the mapped pages is changed, which can make the
 wiki a bit slow.
 
+Here are descriptions of all the supported parameters to the `linkmap`
+directive:
+
+* `pages` - A [[PageSpec]] of the pages to map.
+* `height`, `width` - Limit the size of the map to a given height and width,
+  in inches. Both must be specified for the limiting to take effect, otherwise
+  the map's size is not limited.
+
 This plugin is included in ikiwiki, but is not enabled by default.
 
 If this plugin is enabled, here is a link map of the index page and all