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

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index cd2ef1bc5b762ae7ce693c5d3e561505bba02e14..d50c9b292538d6e220e101343536fd5964140b1a 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,3 +1,6 @@
+[[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"]]
 This plugin generates a hierarchical page map for the wiki. Example usage:
 
        \[[map pages="* and !blog/* and !*/Discussion"]]


@@ -5,15 +8,16 @@ This plugin generates a hierarchical page map for the wiki. Example usage:
 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 of pages instead. 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 !*/*/*"]]

-
-[[tag type/meta]]
+"""]]