X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/2eac55e90efa6aa82f3159385f1398be4b3bf6da..33f479526e0afe70f92ca954ee1085705a8c5743:/doc/plugins/map.mdwn?ds=sidebyside

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 039ed559e..5b009f424 100644
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,16 +1,19 @@
-This plugin generates a hierarchical page map for the wiki. Example usage:
+[[!template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[!tag type/meta type/widget]]
 
-	\[[map pages="* and !blog/*" maxdepth=2]]
+This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]],
+which generates a hierarchical page map for the wiki.
 
-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.
+[[!if test="enabled(map)" then="""
+This will create an a map, for the plugins section of this wiki:
 
-This plugin is included in ikiwiki, but is not enabled by default.
+    \[[!map pages="(plugins or plugins/*) and !*/*/*"]]
 
-If this plugin is enabled, here is a page map for the plugins section
-of this wiki:
+Example:
 
-[[map pages="plugins or plugins/*" maxdepth=3]]
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
 
-[[tag type/meta]]
+It's also possible to search for specific tags or links:
+
+    \[[!map pages="todo/* and !todo/done and !link(todo/done)"]]
+"""]]