]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/map.mdwn
remove wacky meta description tag
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
1 [[template id=plugin name=map author="Alessandro Dotti Contra"]]
2 [[tag type/meta]]
4 This plugin generates a hierarchical page map for the wiki. Example usage:
6         \[[map pages="* and !blog/* and !*/Discussion"]]
8 If the pages to include are not specified, all pages (and other files) in
9 the wiki are mapped.
11 By default, the names of pages are shown in the map. The `show` parameter
12 can be used to show the titles or descriptions of pages instead (as set by
13 the [[meta]] plugin). For example:
15         \[[map pages="* and !blog/* and !*/Discussion" show=title]]
17 Hint: To limit the map to displaying pages less than a certain level deep,
18 use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
20 [[if test="enabled(map)" then="""
21 Here's an example map, for the plugins section of this wiki:
23 [[map pages="(plugins or plugins/*) and !*/*/*"]]
24 """]]