]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/linkmap.mdwn
move example back to plugin
[git.ikiwiki.info.git] / doc / plugins / linkmap.mdwn
index fc754f9fb9de09466ebc706bb5de4124fc2d66c8..b52a87da9b5be2a5bb47b115068bf37945439266 100644 (file)
@@ -1,22 +1,7 @@
-[[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"]]
-
-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.
-
-This plugin is included in ikiwiki, but is not enabled by default.
-
-If this plugin is enabled, here is a link map of the index page and all
-pages it links to:
-
-[[linkmap pages="index or (backlink(index) and !*.png)"]]
+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.