aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/linkmap.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-07 06:58:27 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-07 06:58:27 +0000
commit3e9a6a7d4fa237d488f8570b28dbe88d5277c1ae (patch)
tree28a8a984a08211a2fedd90ae5af5914a0e0cf2e8 /doc/plugins/linkmap.mdwn
parent0a8fc6ddf55697a1ed1f8b277265b430ffe5350c (diff)
downloadikiwiki-3e9a6a7d4fa237d488f8570b28dbe88d5277c1ae.tar
ikiwiki-3e9a6a7d4fa237d488f8570b28dbe88d5277c1ae.tar.gz
size limits
Diffstat (limited to 'doc/plugins/linkmap.mdwn')
-rw-r--r--doc/plugins/linkmap.mdwn8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
index fc754f9fb..e0eda9289 100644
--- a/doc/plugins/linkmap.mdwn
+++ b/doc/plugins/linkmap.mdwn
@@ -14,6 +14,14 @@ 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 [[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.
+
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