X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/297ff849b93e5a75074e321fe65500f0e091601c..685d14bfa04e679781838f460c0f35cba0533fd7:/doc/plugins/map.mdwn?ds=sidebyside diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 3700fadd8..b164d5ca8 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,23 +1,8 @@ [[!template id=plugin name=map author="Alessandro Dotti Contra"]] -[[!tag type/meta]] +[[!tag type/meta type/widget]] -[[!meta description="some page description"]] - -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. 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 !*/*/*"` +This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]], +which generates a hierarchical page map for the wiki. [[!if test="enabled(map)" then=""" Here's an example map, for the plugins section of this wiki: