questions

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index d50c9b292538d6e220e101343536fd5964140b1a..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]]
 
 [[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"]]
 This plugin generates a hierarchical page map for the wiki. Example usage:
 
        \[[map pages="* and !blog/* and !*/Discussion"]]


@@ -9,8 +11,9 @@ 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
 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 of pages instead. For example:
-       
+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,
        \[[map pages="* and !blog/* and !*/Discussion" show=title]]
 
 Hint: To limit the map to displaying pages less than a certain level deep,