aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/map.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-08-18 16:18:45 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-08-18 16:18:45 +0000
commit2eac55e90efa6aa82f3159385f1398be4b3bf6da (patch)
tree02fdf42fd6022569e4d3e4a95ccf727dff85fd34 /doc/plugins/map.mdwn
parent4d6f5e5a144e20bbda1c8e2d7d611b945394448f (diff)
downloadikiwiki-2eac55e90efa6aa82f3159385f1398be4b3bf6da.tar
ikiwiki-2eac55e90efa6aa82f3159385f1398be4b3bf6da.tar.gz
* Add a map plugin contributed by Alessandro Dotti Contra.
Diffstat (limited to 'doc/plugins/map.mdwn')
-rw-r--r--doc/plugins/map.mdwn16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
new file mode 100644
index 000000000..039ed559e
--- /dev/null
+++ b/doc/plugins/map.mdwn
@@ -0,0 +1,16 @@
+This plugin generates a hierarchical page map for the wiki. Example usage:
+
+ \[[map pages="* and !blog/*" maxdepth=2]]
+
+If the pages to include are not specified, all pages (and other files) in
+the wiki are mapped. If the maxdepth parameter is passed, only pages nested
+less than that many levels deep will be included in the map.
+
+This plugin is included in ikiwiki, but is not enabled by default.
+
+If this plugin is enabled, here is a page map for the plugins section
+of this wiki:
+
+[[map pages="plugins or plugins/*" maxdepth=3]]
+
+[[tag type/meta]]