X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/2eac55e90efa6aa82f3159385f1398be4b3bf6da..4e387bc6b65c4d56027ac93498e9782dbaba94d7:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 039ed559e..8f5a9f15e 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,16 +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/*" 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=""" +Here's an example map, for the plugins section of this wiki: -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/*" maxdepth=3]] - -[[tag type/meta]] +[[!map pages="(plugins or plugins/*) and !*/*/*"]] +"""]]