* Allow plugins to add new types of tests that can be used in PageSpecs.
[ikiwiki.git] / doc / plugins / linkmap.mdwn
1 [[template id=plugin name=linkmap included=1 author="Joey Hess"]]
2 [[tag type/meta]]
3 [[tag type/slow]]
4 This plugin uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a
5 set of pages in the wiki. Example usage:
6
7         \[[linkmap pages="* and !blog/* and !*/Discussion"]]
8
9 Only links between mapped pages will be shown; links pointing to or from
10 unmapped pages will be omitted. If the pages to include are not specified,
11 the links between all pages (and other files) in the wiki are mapped. For
12 best results, only a small set of pages should be mapped, since otherwise
13 the map can become very large, unweildy, and complicated. Also, the map is
14 rebuilt whenever one of the mapped pages is changed, which can make the
15 wiki a bit slow.
16
17 Here are descriptions of all the supported parameters to the `linkmap`
18 directive:
19
20 * `pages` - A [[PageSpec]] of the pages to map.
21 * `height`, `width` - Limit the size of the map to a given height and width,
22   in inches. Both must be specified for the limiting to take effect, otherwise
23   the map's size is not limited.
24
25 [[if test="enabled(linkmap)" then="""
26 Here is an example link map, of the index page and all pages it links to:
27
28 [[linkmap pages="index or (backlink(index) and !*.png)"]]
29 """]