web commit by simon: link fix

[git.ikiwiki.info.git] / doc / plugins / map.mdwn

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 7afc915d6d6144ff298b97ac4f580b6da406f95c..df34d77cd8007cd72e344da43c6f8e871a2b7b35 100644 (file)
--- 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,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.
 
+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 [[PageSpec]] like this: `pages="* and !*/*/*"`
+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: