X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9d7375c3b263e77da29a5db22af480db8b99d990..84e6c4fa665703133b5778e92c045897df496e97:/doc/plugins/map.mdwn diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 7780c3306..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,13 +10,17 @@ 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]] -This plugin is included in ikiwiki, but is not enabled by default. -It was contributed by Alessandro Dotti Contra. +Hint: To limit the map to displaying pages less than a certain level deep, +use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"` -If this plugin is enabled, here is a page map for the plugins section -of this wiki: +[[if test="enabled(map)" then=""" +Here's an example map, for the plugins section of this wiki: [[map pages="(plugins or plugins/*) and !*/*/*"]] +"""]]