]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/map.mdwn
add metadata
[ikiwiki.git] / doc / plugins / map.mdwn
index 039ed559e5a34645ca4f33947265b5875dafc70e..01f61e5b3a081c4ea7acb993e774e1298ac8d069 100644 (file)
@@ -1,16 +1,20 @@
+[[template id=plugin name=map included=1 author="Alessandro Dotti Contra"]]
+[[tag type/meta]]
+
 This plugin generates a hierarchical page map for the wiki. Example usage:
 
-       \[[map pages="* and !blog/*" maxdepth=2]]
+       \[[map pages="* and !blog/* and !*/Discussion"]]
 
 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.
+the wiki are mapped.
+
+Hint: To limit the map to displaying pages less than a certian level deep,
+use a [[PageSpec]] like this: `pages="* and !*/*/*"`
 
 This plugin is included in ikiwiki, but is not enabled by default.
+It was contributed by Alessandro Dotti Contra.
 
 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]]
+[[map pages="(plugins or plugins/*) and !*/*/*"]]