diff options
author | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
commit | 9921a4a8a1a696ce69acce5e14943f0149d926ff (patch) | |
tree | 926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/linkmap.mdwn | |
parent | 7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff) | |
download | ikiwiki-9921a4a8a1a696ce69acce5e14943f0149d926ff.tar ikiwiki-9921a4a8a1a696ce69acce5e14943f0149d926ff.tar.gz |
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/linkmap.mdwn')
-rw-r--r-- | doc/ikiwiki/directive/linkmap.mdwn | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/linkmap.mdwn b/doc/ikiwiki/directive/linkmap.mdwn new file mode 100644 index 000000000..ecc12bd77 --- /dev/null +++ b/doc/ikiwiki/directive/linkmap.mdwn @@ -0,0 +1,24 @@ +The `linkmap` directive is supplied by the [[!iki plugins/linkmap]] plugin. + +This directive 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"]] + +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. + +Here are descriptions of all the supported parameters to the `linkmap` +directive: + +* `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. + +[[!meta robots="noindex, follow"]] |