web commit by tschwinge: Further explanation.

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

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

 [[tag type/meta]]
 [[tag type/slow]]
 [[tag type/meta]]
 [[tag type/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"]]
 set of pages in the wiki. Example usage:
 
        \[[linkmap pages="* and !blog/* and !*/Discussion"]]


@@ -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)"]]

+"""]]