aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/map.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-06-15 16:11:11 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-06-15 16:11:11 -0400
commit71d984b3109e7d5ab9e7e41bb50dc00a1787dd6f (patch)
tree71a7f6e25ed7201a963bef15d114df3b2731a435 /doc/plugins/map.mdwn
parent0f83e169e046eaff9e2d20a1338c3fbd5738284d (diff)
downloadikiwiki-71d984b3109e7d5ab9e7e41bb50dc00a1787dd6f.tar
ikiwiki-71d984b3109e7d5ab9e7e41bb50dc00a1787dd6f.tar.gz
map: Add a "show" parameter. "show=title" can be used to display page titles, rather than the default page name. Based on a patch from Jaldhar H. Vyas, Closes: #484510
Diffstat (limited to 'doc/plugins/map.mdwn')
-rw-r--r--doc/plugins/map.mdwn5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 44ce9edd4..d50c9b292 100644
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -8,6 +8,11 @@ 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 of pages instead. 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 !*/*/*"`