]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/map.mdwn
map: Add a "show" parameter. "show=title" can be used to display page titles, rather...
[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 By default, the names of pages are shown in the map. The `show` parameter
12 can be used to show the titles of pages instead. For example:
13         
14         \[[map pages="* and !blog/* and !*/Discussion" show=title]]
15
16 Hint: To limit the map to displaying pages less than a certain level deep,
17 use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
18
19 [[if test="enabled(map)" then="""
20 Here's an example map, for the plugins section of this wiki:
21
22 [[map pages="(plugins or plugins/*) and !*/*/*"]]
23 """]]