X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7960031135e74f6d36abc4294dbadb687117222c..8d9ec24232ede981face0c3eafbce71b74c4725a:/doc/plugins/map.mdwn?ds=sidebyside

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 44ce9edd4..df34d77cd 100644
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,6 +1,8 @@
 [[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,6 +10,12 @@ 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.
 
+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 !*/*/*"`