]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/map.mdwn
really generate HTML5 by default
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
index f4dd91e48a3ca5113be1a462aae69324e91f813b..5b009f424db9141cd1afc8bbb5c6726fb5816934 100644 (file)
@@ -1,5 +1,19 @@
 [[!template id=plugin name=map author="Alessandro Dotti Contra"]]
-[[!tag type/meta]]
+[[!tag type/meta type/widget]]
 
-This plugin implements the [[ikiwiki/directive/map]] [[ikiwiki/directive]].
-The directive generates a hierarchical page map for the wiki.
+This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]],
+which generates a hierarchical page map for the wiki.
+
+[[!if test="enabled(map)" then="""
+This will create an a map, for the plugins section of this wiki:
+
+    \[[!map pages="(plugins or plugins/*) and !*/*/*"]]
+
+Example:
+
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
+
+It's also possible to search for specific tags or links:
+
+    \[[!map pages="todo/* and !todo/done and !link(todo/done)"]]
+"""]]