Migrate doc/todo via prefix_directives

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 44ce9edd4dfa4efa0d57bb8b85d548b0a9787489..472f62461d31275e9c504d2cd872a832822ad1af 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,18 +1,26 @@
 [[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:
 
 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.
 

+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]]
+

 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:
 
 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:
 

-[[map pages="(plugins or plugins/*) and !*/*/*"]]
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]

 """]]
 """]]