-[[template id=plugin name=map author="Alessandro Dotti Contra"]]
-[[tag type/meta]]
+[[!template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[!tag type/meta type/widget]]
-[[meta description="some page description"]]
+This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]],
+which generates a hierarchical page map for the wiki.
-This plugin generates a hierarchical page map for the wiki. Example usage:
+[[!if test="enabled(map)" then="""
+This will create an a map, for the plugins section of this wiki:
- \[[map pages="* and !blog/* and !*/Discussion"]]
+ \[[!map pages="(plugins or plugins/*) and !*/*/*"]]
-If the pages to include are not specified, all pages (and other files) in
-the wiki are mapped.
+Example:
-By default, the names of pages are shown in the map. Since ikiwiki 2.51,
-The `show` parameter
-can be used to show the titles or descriptions of pages instead (as set by
-the [[meta]] plugin). For example:
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
- \[[map pages="* and !blog/* and !*/Discussion" show=title]]
+It's also possible to search for specific tags or links:
-Hint: To limit the map to displaying pages less than a certain level deep,
-use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
-
-[[if test="enabled(map)" then="""
-Here's an example map, for the plugins section of this wiki:
-
-[[map pages="(plugins or plugins/*) and !*/*/*"]]
+ \[[!map pages="todo/* and !todo/done and !link(todo/done)"]]
"""]]