http(oop)s

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 40e284256a32fa019ec059aa262882c6df5b7e6b..3700fadd84f4f1de475ec0984f6739038506c917 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]]
+
+[[!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.
 

-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.
+       \[[!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:

 
 

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