]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/linkmap.mdwn
thoughts
[git.ikiwiki.info.git] / doc / plugins / linkmap.mdwn
index b52a87da9b5be2a5bb47b115068bf37945439266..89cb9d8aeb5ff8735ca1dd551bc6787c483f3673 100644 (file)
@@ -2,6 +2,12 @@
 [[!tag type/meta]]
 [[!tag type/slow]]
 
 [[!tag type/meta]]
 [[!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)"]]
+"""]]