]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/map.mdwn
Migrate doc/todo via prefix_directives
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
index ce2ebda3f588ddcba2b83f8aa7d7b873ce280537..472f62461d31275e9c504d2cd872a832822ad1af 100644 (file)
@@ -5,17 +5,16 @@
 
 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. Since ikiwiki 2.51, 
-The `show` parameter
+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:
 
 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]]
+       \[[!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 !*/*/*"`
 
 Hint: To limit the map to displaying pages less than a certain level deep,
 use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
@@ -23,5 +22,5 @@ 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:
 
-[[map pages="(plugins or plugins/*) and !*/*/*"]]
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
 """]]
 """]]