X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/479c7a1ea62d8fce3ef54f9deae89230d0b52a5d..8d9ec24232ede981face0c3eafbce71b74c4725a:/doc/plugins/map.mdwn?ds=inline diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 3d44164ae..df34d77cd 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,6 +1,8 @@ -[[template id=plugin name=map included=1 author="Alessandro Dotti Contra"]] +[[template id=plugin name=map author="Alessandro Dotti Contra"]] [[tag type/meta]] +[[meta description="some page description"]] + This plugin generates a hierarchical page map for the wiki. Example usage: \[[map pages="* and !blog/* and !*/Discussion"]] @@ -8,8 +10,14 @@ This plugin generates a hierarchical page map for the wiki. Example usage: If the pages to include are not specified, all pages (and other files) in the wiki are mapped. -Hint: To limit the map to displaying pages less than a certian level deep, -use a [[PageSpec]] like this: `pages="* and !*/*/*"` +By default, the names of pages are shown in the map. 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="* and !blog/* and !*/Discussion" show=title]] + +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: