]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/map.mdwn
039ed559e5a34645ca4f33947265b5875dafc70e
[ikiwiki.git] / doc / plugins / map.mdwn
1 This plugin generates a hierarchical page map for the wiki. Example usage:
2
3         \[[map pages="* and !blog/*" maxdepth=2]]
4
5 If the pages to include are not specified, all pages (and other files) in
6 the wiki are mapped. If the maxdepth parameter is passed, only pages nested
7 less than that many levels deep will be included in the map.
8
9 This plugin is included in ikiwiki, but is not enabled by default.
10
11 If this plugin is enabled, here is a page map for the plugins section
12 of this wiki:
13
14 [[map pages="plugins or plugins/*" maxdepth=3]]
15
16 [[tag type/meta]]