Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / ikiwiki / directive / map.mdwn
1 The `map` directive is supplied by the [[!iki plugins/map desc=map]] plugin.
2
3 This directive generates a hierarchical page map for the wiki. Example usage:
4
5         \[[!map pages="* and !blog/* and !*/Discussion"]]
6
7 If the pages to include are not specified, all pages (and other files) in
8 the wiki are mapped.
9
10 By default, the names of pages are shown in the map. The `show` parameter
11 can be used to show the titles or descriptions of pages instead (as set by
12 the [[meta]] directive). 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 [[!meta robots="noindex, follow"]]