oh, we don't use comments here, do we?

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

diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 3700fadd84f4f1de475ec0984f6739038506c917..5b009f424db9141cd1afc8bbb5c6726fb5816934 100644 (file)
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -1,26 +1,19 @@
 [[!template id=plugin name=map author="Alessandro Dotti Contra"]]
 [[!template id=plugin name=map author="Alessandro Dotti Contra"]]

-[[!tag type/meta]]
+[[!tag type/meta type/widget]]

 
 

-[[!meta description="some page description"]]
+This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]],
+which generates a hierarchical page map for the wiki.

 
 

-This plugin generates a hierarchical page map for the wiki. Example usage:
-
-       \[[!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 test="enabled(map)" then="""
+This will create an a map, for the plugins section of this wiki:

 
 

-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="(plugins or plugins/*) and !*/*/*"]]

 
 

-       \[[!map pages="* and !blog/* and !*/Discussion" show=title]]
+Example:

 
 

-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:
+It's also possible to search for specific tags or links:

 
 

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

 """]]
 """]]