web commit by MarkusSchaber

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

diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
index fc754f9fb9de09466ebc706bb5de4124fc2d66c8..e54d8ec89e5908ffe302b12ddeb28460fd1369ce 100644 (file)
--- a/doc/plugins/linkmap.mdwn
+++ b/doc/plugins/linkmap.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=linkmap included=1 author="Joey Hess"]]
+[[template id=plugin name=linkmap author="Joey Hess"]]

 [[tag type/meta]]
 [[tag type/slow]]
 This plugin uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a
 [[tag type/meta]]
 [[tag type/slow]]
 This plugin uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a


@@ -14,9 +14,16 @@ 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.
 
 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)"]]
 
 [[linkmap pages="index or (backlink(index) and !*.png)"]]

+"""]