X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/68a8d7b1ccb6f053d911ac18fb5932adc3b67314..d6b87bd25ec6f466c6d3c486b4e923377ad8ee2a:/doc/plugins/linkmap.mdwn diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn index 6ac840ac3..89cb9d8ae 100644 --- a/doc/plugins/linkmap.mdwn +++ b/doc/plugins/linkmap.mdwn @@ -1,22 +1,13 @@ -[[template id=plugin name=linkmap included=1 author="Joey Hess"]] -[[tag type/meta]] -[[tag type/slow]] -This plugin uses graphviz 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. +[[!if test="enabled(linkmap)" then=""" +Here is an example link map, of the index page and all pages it links to: -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)"]] +[[!linkmap pages="index or (backlink(index) and !*.png)"]] +"""]]