summaryrefslogtreecommitdiff
path: root/doc/plugins/map.mdwn
blob: 44ce9edd4dfa4efa0d57bb8b85d548b0a9787489 (plain)

[[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"]]

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 certain level deep, use a [[ikiwiki/PageSpec]] like this: pages="* and !*/*/*"

[[if test="enabled(map)" then=""" Here's an example map, for the plugins section of this wiki:

[[map pages="(plugins or plugins/) and !//"]] """]]