X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8f8959c96ecc69ecc75b5e5c76b52345afce94d8..e4b096ac411494416d73e344e0aaeaacabf2f266:/doc/plugins/map.mdwn?ds=inline

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 01f61e5b3..3700fadd8 100644
--- 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"]]
-[[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"]]
+	\[[!map pages="* and !blog/* and !*/Discussion"]]
 
 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 !*/*/*"]]
+"""]]