filecheck: New plugin factoring out the PageSpec additions that were originally part...

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 01f61e5b3a081c4ea7acb993e774e1298ac8d069..9283eb4cf9f07c6e0c44bb2e43ae17e448753a7d 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,20 +1,24 @@
-[[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]]

 
 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.
 

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

 
 

-This plugin is included in ikiwiki, but is not enabled by default.
-It was contributed by Alessandro Dotti Contra.
+       \[[!map pages="* and !blog/* and !*/Discussion" show=title]]

 
 

-If this plugin is enabled, here is a page 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 !*/*/*"`

 
 

-[[map pages="(plugins or plugins/*) and !*/*/*"]]
+[[!if test="enabled(map)" then="""
+Here's an example map, for the plugins section of this wiki:
+
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
+"""]]