diff options
Diffstat (limited to 'doc/plugins/linkmap.mdwn')
| -rw-r--r-- | doc/plugins/linkmap.mdwn | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn new file mode 100644 index 000000000..35dcf8f56 --- /dev/null +++ b/doc/plugins/linkmap.mdwn @@ -0,0 +1,23 @@ +[[template id=plugin name=linkmap included=1 author="Joey Hess"]] +[[tag type/meta]] +[[tag type/slow]] +the mapped pages is changed, which can make the wiki a bit slow. +This plugin uses graphviz to generate a graph showing the links between a +set of pages in the wiki. Example usage: + + \[[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, +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. + +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)"]] |