-[[template id=plugin name=linkmap included=1 author="Joey Hess"]]
+[[template id=plugin name=linkmap 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"]]
rebuilt whenever one of the mapped pages is changed, which can make the
wiki a bit slow.
-This plugin is included in ikiwiki, but is not enabled by default.
+Here are descriptions of all the supported parameters to the `linkmap`
+directive:
-If this plugin is enabled, here is a link map of the index page and all
-pages it links to:
+* `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.
+
+[[if test="enabled(linkmap)" then="""
+Here is an example link map, of the index page and all pages it links to:
[[linkmap pages="index or (backlink(index) and !*.png)"]]
+"""]