X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..24168b993e65994d2996d02bfaa36fb80bb65ca7:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 592a20706..b164d5ca8 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,19 +1,11 @@ -[[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 type/widget]] -This plugin generates a hierarchical page map for the wiki. Example usage: +This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]], +which generates a hierarchical page map for the wiki. - \[[map pages="* and !blog/* and !*/Discussion"]] +[[!if test="enabled(map)" then=""" +Here's an example map, for the plugins section of this wiki: -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. - -If this plugin is enabled, here is a page map for the plugins section -of this wiki: - -[[map pages="(plugins or plugins/*) and !*/*/*"]] +[[!map pages="(plugins or plugins/*) and !*/*/*"]] +"""]]