]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/linkmap.mdwn
* Add a linkmap plugin (requires graphviz).
[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 the mapped pages is changed, which can make the wiki a bit slow.
5 This plugin uses graphviz to generate a graph showing the links between a
6 set of pages in the wiki. Example usage:
7
8         \[[linkmap pages="* and !blog/* and !*/Discussion"]]
9
10 Only links between mapped pages will be shown; links pointing to or from
11 unmapped pages will be omitted. If the pages to include are not specified,
12 the links between all pages (and other files) in the wiki are mapped. For
13 best results, only a small set of pages should be mapped, since otherwise
14 the map can become very large, unweildy, and complicated. Also, the map is
15 rebuilt whenever one of the mapped pages is changed, which can make the
16 wiki a bit slow.
17
18 This plugin is included in ikiwiki, but is not enabled by default.
19
20 If this plugin is enabled, here is a link map of the index page and all
21 pages it links to:
22
23 [[linkmap pages="index or (backlink(index) and !*.png)"]]