X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/2eac55e90efa6aa82f3159385f1398be4b3bf6da..706bcbfe66841cad47615b2178ac430504e0cf17:/doc/plugins/map.mdwn?ds=inline

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 039ed559e..df34d77cd 100644
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,16 +1,26 @@
+[[template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[tag type/meta]]
+
+[[meta description="some page description"]]
+
 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.
+By default, the names of pages are shown in the map. The `show` parameter
+can be used to show the titles or descriptions of pages instead (as set by
+the [[meta]] plugin). For example:
 
-If this plugin is enabled, here is a page map for the plugins section
-of this wiki:
+	\[[map pages="* and !blog/* and !*/Discussion" show=title]]
 
-[[map pages="plugins or plugins/*" maxdepth=3]]
+Hint: To limit the map to displaying pages less than a certain level deep,
+use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
 
-[[tag type/meta]]
+[[if test="enabled(map)" then="""
+Here's an example map, for the plugins section of this wiki:
+
+[[map pages="(plugins or plugins/*) and !*/*/*"]]
+"""]]