Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 3d44164ae481df7b7ff5437d66e1d032275950c4..d50c9b292538d6e220e101343536fd5964140b1a 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=map included=1 author="Alessandro Dotti Contra"]]
+[[template id=plugin name=map author="Alessandro Dotti Contra"]]

 [[tag type/meta]]
 
 This plugin generates a hierarchical page map for the wiki. Example usage:
 [[tag type/meta]]
 
 This plugin generates a hierarchical page map for the wiki. Example usage:


@@ -8,8 +8,13 @@ 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.
 
 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 of pages instead. 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 !*/*/*"`

 
 [[if test="enabled(map)" then="""
 Here's an example 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: