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

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index d50c9b292538d6e220e101343536fd5964140b1a..9283eb4cf9f07c6e0c44bb2e43ae17e448753a7d 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,23 +1,24 @@
-[[template id=plugin name=map author="Alessandro Dotti Contra"]]
-[[tag type/meta]]
+[[!template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[!tag type/meta]]
 
 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.
 
 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]]
+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 !*/*/*"`
 
-[[if test="enabled(map)" then="""
+[[!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 !*/*/*"]]
 """]]