01f61e5b3a081c4ea7acb993e774e1298ac8d069
[ikiwiki.git] / doc / plugins / map.mdwn
1 [[template id=plugin name=map included=1 author="Alessandro Dotti Contra"]]
2 [[tag type/meta]]
3
4 This plugin generates a hierarchical page map for the wiki. Example usage:
5
6         \[[map pages="* and !blog/* and !*/Discussion"]]
7
8 If the pages to include are not specified, all pages (and other files) in
9 the wiki are mapped.
10
11 Hint: To limit the map to displaying pages less than a certian level deep,
12 use a [[PageSpec]] like this: `pages="* and !*/*/*"`
13
14 This plugin is included in ikiwiki, but is not enabled by default.
15 It was contributed by Alessandro Dotti Contra.
16
17 If this plugin is enabled, here is a page map for the plugins section
18 of this wiki:
19
20 [[map pages="(plugins or plugins/*) and !*/*/*"]]