ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / ikiwiki / directive / linkmap.mdwn
1 The `linkmap` directive is supplied by the [[!iki plugins/linkmap desc=linkmap]] plugin.
2
3 This directive uses [graphviz](http://www.graphviz.org/) to generate a
4 graph showing the links between a set of pages in the wiki. Example usage:
5
6         \[[!linkmap pages="* and !blog/* and !*/Discussion"]]
7
8 Only links between mapped pages will be shown; links pointing to or from
9 unmapped pages will be omitted. If the pages to include are not specified,
10 the links between all pages (and other files) in the wiki are mapped. 
11
12 Here are descriptions of all the supported parameters to the `linkmap`
13 directive:
14
15 * `pages` - A [[ikiwiki/PageSpec]] of the pages to map.
16 * `height`, `width` - Limit the size of the map to a given height and width,
17   in inches. Both must be specified for the limiting to take effect, otherwise
18   the map's size is not limited.
19 * `connected` - Controls whether to include pages on the map that link to
20   no other pages (connected=no, the default), or to only show pages that
21   link to others (connected=yes).
22
23 For best results, only a small set of pages should be mapped, since
24 otherwise the map can become very large, unwieldy, and complicated.
25 If too many pages are included, the map may get so large that graphviz
26 cannot render it. Using the `connected` parameter is a good way to prune
27 out pages that clutter the map.
28
29 [[!meta robots="noindex, follow"]]