X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/d5e65e582a34ae2494fee493ddcb2b959e4a4bce..3a1c8c2b463b8a4f6b3b2c866c5e1b1500f95193:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 3700fadd8..8f5a9f15e 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,23 +1,8 @@ [[!template id=plugin name=map author="Alessandro Dotti Contra"]] [[!tag type/meta]] -[[!meta description="some page description"]] - -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. - -By default, the names of pages are shown in the map. The `show` parameter -can be used to show the titles or descriptions of pages instead (as set by -the [[meta]] plugin). For example: - - \[[!map pages="* and !blog/* and !*/Discussion" show=title]] - -Hint: To limit the map to displaying pages less than a certain level deep, -use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"` +This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]], +which generates a hierarchical page map for the wiki. [[!if test="enabled(map)" then=""" Here's an example map, for the plugins section of this wiki: