X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/63edea27bc71c3bdf1837f994fb7effdd93fb2dd..be092e56395fd70df71a062492e97794650ebf40:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index cd2ef1bc5..8f5a9f15e 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,19 +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/* and !*/Discussion"]] +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 test="enabled(map)" then=""" +Here's an example map, for the plugins section of this wiki: -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. -It was contributed by Alessandro Dotti Contra. - -If this plugin is enabled, here is a page map for the plugins section -of this wiki: - -[[map pages="(plugins or plugins/*) and !*/*/*"]] - -[[tag type/meta]] +[[!map pages="(plugins or plugins/*) and !*/*/*"]] +"""]]