]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/map.mdwn
patch plugin documentation to refer to directive pages
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
index 7afc915d6d6144ff298b97ac4f580b6da406f95c..f4dd91e48a3ca5113be1a462aae69324e91f813b 100644 (file)
@@ -1,18 +1,5 @@
-[[template id=plugin name=map author="Alessandro Dotti Contra"]]
-[[tag type/meta]]
+[[!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/* and !*/Discussion"]]
-
-If the pages to include are not specified, all pages (and other files) in
-the wiki are mapped.
-
-Hint: To limit the map to displaying pages less than a certain level deep,
-use a [[PageSpec]] like this: `pages="* and !*/*/*"`
-
-[[if test="enabled(map)" then="""
-Here's an example map, for the plugins section of this wiki:
-
-[[map pages="(plugins or plugins/*) and !*/*/*"]]
-"""]]
+This plugin implements the [[ikiwiki/directive/map]] [[ikiwiki/directive]].
+The directive generates a hierarchical page map for the wiki.