Updated patch

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 7780c3306015549baadab42f75ce93a261d0c4c9..472f62461d31275e9c504d2cd872a832822ad1af 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,20 +1,26 @@
-[[template id=plugin name=map included=1 author="""Alessandro Dotti Contra"""]]
+[[template id=plugin name=map author="Alessandro Dotti Contra"]]

 [[tag type/meta]]
 
 [[tag type/meta]]
 

+[[meta description="some page description"]]
+

 This plugin generates a hierarchical page map for the wiki. Example usage:
 
 This plugin generates a hierarchical page map for the wiki. Example usage:
 

-       \[[map pages="* and !blog/* and !*/Discussion"]]
+       \[[!map pages="* and !blog/* and !*/Discussion"]]

 
 If the pages to include are not specified, all pages (and other files) in
 the wiki are mapped.
 
 
 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 !*/*/*"]]
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
+"""]]