]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/map.mdwn
remove wacky meta description tag
[git.ikiwiki.info.git] / doc / plugins / map.mdwn
index 7afc915d6d6144ff298b97ac4f580b6da406f95c..af18a8f569682cde4adc5b4be2e7fe4fa412ecf4 100644 (file)
@@ -8,8 +8,14 @@ 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.
 
+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="* and !blog/* and !*/Discussion" show=title]]
+
 Hint: To limit the map to displaying pages less than a certain level deep,
-use a [[PageSpec]] like this: `pages="* and !*/*/*"`
+use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
 
 [[if test="enabled(map)" then="""
 Here's an example map, for the plugins section of this wiki: