web commit by PaulWise: add headinganchors plugin

[ikiwiki.git] / doc / plugins / map.mdwn

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 039ed559e5a34645ca4f33947265b5875dafc70e..cc4e857b45c818628f627a08e94b6beca0a55605 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,16 +1,18 @@
+[[template id=plugin name=map 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.
 
-This plugin is included in ikiwiki, but is not enabled by default.
+Hint: To limit the map to displaying pages less than a certian level deep,
+use a [[PageSpec]] like this: `pages="* and !*/*/*"`
 
-If this plugin is enabled, here is a page map for the plugins section
-of this wiki:
+[[if test="enabled(map)" then="""
+Here's an example map, for the plugins section of this wiki:
 
-[[map pages="plugins or plugins/*" maxdepth=3]]
-
-[[tag type/meta]]
+[[map pages="(plugins or plugins/*) and !*/*/*"]]
+"""]]