X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/6f6495d7a6a021245a9d636ceabb8491285f88f2..bb9a8fb5f2b2d3b53f8d117df49483dd0c0dc91a:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 40e284256..44ce9edd4 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,3 +1,6 @@ +[[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"]] @@ -5,14 +8,11 @@ This plugin generates a hierarchical page map for the wiki. Example usage: 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 certian level deep, -use a [[PageSpec]] like this: `pages="* and !*/*/*"` - -This plugin is included in ikiwiki, but is not enabled by default. +Hint: To limit the map to displaying pages less than a certain level deep, +use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"` -If this plugin is enabled, here is a page map for the plugins section -of this wiki: +[[if test="enabled(map)" then=""" +Here's an example map, for the plugins section of this wiki: [[map pages="(plugins or plugins/*) and !*/*/*"]] - -[[tag type/meta]] +"""]]