From ce0037e0ff41a75d0e6c947ef547ef9630c54be9 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Thu, 14 Oct 2010 13:38:20 +0200 Subject: Sync with ikiwiki 3.20100926. --- ikiwiki/directive/map.mdwn | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 ikiwiki/directive/map.mdwn (limited to 'ikiwiki/directive/map.mdwn') diff --git a/ikiwiki/directive/map.mdwn b/ikiwiki/directive/map.mdwn new file mode 100644 index 0000000..a031dc7 --- /dev/null +++ b/ikiwiki/directive/map.mdwn @@ -0,0 +1,22 @@ +The `map` directive is supplied by the [[!iki plugins/map desc=map]] plugin. + +This directive 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. The `show` parameter +can be used to show the titles or descriptions of pages instead (as set by +the [[meta]] directive). For example: + + \[[!map pages="* and !blog/* and !*/Discussion" show=title]] + + \[[!map pages="* and !blog/* and !*/Discussion" show=description]] + +Hint: To limit the map to displaying pages less than a certain level deep, +use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"` + +[[!meta robots="noindex, follow"]] -- cgit v1.2.3