From 9921a4a8a1a696ce69acce5e14943f0149d926ff Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 11 Sep 2008 18:41:26 -0400 Subject: Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki. --- doc/ikiwiki/directive/map.mdwn | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 doc/ikiwiki/directive/map.mdwn (limited to 'doc/ikiwiki/directive/map.mdwn') diff --git a/doc/ikiwiki/directive/map.mdwn b/doc/ikiwiki/directive/map.mdwn new file mode 100644 index 000000000..543470864 --- /dev/null +++ b/doc/ikiwiki/directive/map.mdwn @@ -0,0 +1,19 @@ +The `map` directive is supplied by the [[!iki plugins/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]] 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 !*/*/*"` + +[[!meta robots="noindex, follow"]] -- cgit v1.2.3