X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/3e9a6a7d4fa237d488f8570b28dbe88d5277c1ae..bb394fdae8ba488f1031d6f053f1544c689a3628:/doc/plugins/linkmap.mdwn diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn index e0eda9289..935f3d3cd 100644 --- a/doc/plugins/linkmap.mdwn +++ b/doc/plugins/linkmap.mdwn @@ -1,10 +1,10 @@ -[[template id=plugin name=linkmap included=1 author="Joey Hess"]] -[[tag type/meta]] -[[tag type/slow]] +[[!template id=plugin name=linkmap author="[[Joey]]"]] +[[!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: - \[[linkmap pages="* and !blog/* and !*/Discussion"]] + \[[!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, @@ -17,14 +17,13 @@ wiki a bit slow. Here are descriptions of all the supported parameters to the `linkmap` directive: -* `pages` - A [[PageSpec]] of the pages to map. +* `pages` - A [[ikiwiki/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. -This plugin is included in ikiwiki, but is not enabled by default. +[[!if test="enabled(linkmap)" then=""" +Here is an example link map, of the index page and all pages it links to: -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)"]] +"""]]