cc4e857b45c818628f627a08e94b6beca0a55605
[ikiwiki.git] / doc / plugins / map.mdwn
1 [[template id=plugin name=map 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 [[if test="enabled(map)" then="""
15 Here's an example map, for the plugins section of this wiki:
16
17 [[map pages="(plugins or plugins/*) and !*/*/*"]]
18 """]]