X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/63edea27bc71c3bdf1837f994fb7effdd93fb2dd..65dca9f89d82cc512f1c10ac8cf70696243e650a:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index cd2ef1bc5..7afc915d6 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,15 +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, +Hint: To limit the map to displaying pages less than a certain 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: +[[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]] +"""]]