Merge branch 'master' of git://git.ikiwiki.info

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

diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
index b52a87da9b5be2a5bb47b115068bf37945439266..7e51cd935db00a9540c0600410d506c6ebb22f74 100644 (file)
--- a/doc/plugins/linkmap.mdwn
+++ b/doc/plugins/linkmap.mdwn
@@ -1,7 +1,14 @@
 [[!template id=plugin name=linkmap author="[[Joey]]"]]
 [[!tag type/meta]]
+[[!tag type/widget]]
 [[!tag type/slow]]
 
-This plugin implements the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]].
-The directive uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a
-set of pages in the wiki.
+This plugin provides the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]].
+It uses [graphviz](http://www.graphviz.org/) to generate a graph showing the
+links between a set of pages in the wiki.
+
+[[!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)"]]
+"""]]