]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/linkmap.mdwn
Merge commit 'upstream/master' into pub/master
[git.ikiwiki.info.git] / doc / plugins / linkmap.mdwn
index 50d197f2ffba8dac5808b6ad99242982fead37e4..89cb9d8aeb5ff8735ca1dd551bc6787c483f3673 100644 (file)
@@ -1,29 +1,13 @@
-[[template id=plugin name=linkmap included=1 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
-set of pages in the wiki. Example usage:
+[[!template id=plugin name=linkmap author="[[Joey]]"]]
+[[!tag type/meta]]
+[[!tag type/slow]]
 
-       \[[linkmap pages="* and !blog/* and !*/Discussion"]]
+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.
 
-Only links between mapped pages will be shown; links pointing to or from
-unmapped pages will be omitted. If the pages to include are not specified,
-the links between all pages (and other files) in the wiki are mapped. For
-best results, only a small set of pages should be mapped, since otherwise
-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.
-
-Here are descriptions of all the supported parameters to the `linkmap`
-directive:
-
-* `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="""
+[[!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)"]]
+"""]]