X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..c4de26ad48e0a4e9c88ae15471f6619b2611bec2:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 592a20706..9283eb4cf 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,19 +1,24 @@ -[[template id=plugin name=map included=1 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"]] + \[[!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 certian level deep, -use a [[PageSpec]] like this: `pages="* and !*/*/*"` +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: -This plugin is included in ikiwiki, but is not enabled by default. + \[[!map pages="* and !blog/* and !*/Discussion" show=title]] -If this plugin is enabled, here is a page map for the plugins section -of this wiki: +Hint: To limit the map to displaying pages less than a certain level deep, +use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"` -[[map pages="(plugins or plugins/*) and !*/*/*"]] +[[!if test="enabled(map)" then=""" +Here's an example map, for the plugins section of this wiki: + +[[!map pages="(plugins or plugins/*) and !*/*/*"]] +"""]]