]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/map.mdwn
Merge commit 'upstream/master' into pub/master
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
index 40e284256a32fa019ec059aa262882c6df5b7e6b..8f5a9f15e23cb2477fcaffe26d36c0cb99b6d1ac 100644 (file)
@@ -1,18 +1,11 @@
-This plugin generates a hierarchical page map for the wiki. Example usage:
+[[!template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[!tag type/meta]]
 
-       \[[map pages="* and !blog/* and !*/Discussion"]]
+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 test="enabled(map)" then="""
+Here's an example map, for the plugins section of this wiki:
 
-Hint: To limit the map to displaying pages less than a certian level deep,
-use a [[PageSpec]] like this: `pages="* and !*/*/*"`
-
-This plugin is included in ikiwiki, but is not enabled by default.
-
-If this plugin is enabled, here is a page map for the plugins section
-of this wiki:
-
-[[map pages="(plugins or plugins/*) and !*/*/*"]]
-
-[[tag type/meta]]
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
+"""]]