]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/map.mdwn
optimise brokenlinks by gathering the data when calculating backlinks
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
index ce2ebda3f588ddcba2b83f8aa7d7b873ce280537..8f5a9f15e23cb2477fcaffe26d36c0cb99b6d1ac 100644 (file)
@@ -1,27 +1,11 @@
-[[template id=plugin name=map author="Alessandro Dotti Contra"]]
-[[tag type/meta]]
+[[!template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[!tag type/meta]]
 
-[[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.
-
-By default, the names of pages are shown in the map. Since ikiwiki 2.51, 
-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="* 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 !*/*/*"`
-
-[[if test="enabled(map)" then="""
+[[!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 !*/*/*"]]
 """]]