diff options
author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/linkmap.mdwn | |
parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) | |
download | ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar.gz |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/linkmap.mdwn')
-rw-r--r-- | doc/plugins/linkmap.mdwn | 28 |
1 files changed, 3 insertions, 25 deletions
diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn index 935f3d3cd..b52a87da9 100644 --- a/doc/plugins/linkmap.mdwn +++ b/doc/plugins/linkmap.mdwn @@ -1,29 +1,7 @@ [[!template id=plugin name=linkmap author="[[Joey]]"]] [[!tag type/meta]] [[!tag type/slow]] -This plugin 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. - -[[!if test="enabled(linkmap)" then=""" -Here is an example link map, of the index page and all pages it links to: - -[[!linkmap pages="index or (backlink(index) and !*.png)"]] -"""]] +This plugin implements the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]]. +The directive uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a +set of pages in the wiki. |