X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/116282ab7f144ad5fdb63fc5105e94dc8e147abf..3d2be49420b0f29f169ec015f11af1f0624b9ec9:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index ce2ebda3f..b164d5ca8 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,27 +1,11 @@ -[[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: - - \[[map pages="* and !blog/* and !*/Discussion"]] - -If the pages to include are not specified, all pages (and other files) in -the wiki are mapped. - -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="* 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=""" +[[!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="(plugins or plugins/*) and !*/*/*"]] """]]