doc/plugins/map.mdwn

   1 [[template id=plugin name=map author="Alessandro Dotti Contra"]]
   2 [[tag type/meta]]
   3
   4 [[meta description="some page description"]]
   5
   6 This plugin generates a hierarchical page map for the wiki. Example usage:
   7
   8         \[[map pages="* and !blog/* and !*/Discussion"]]
   9
  10 If the pages to include are not specified, all pages (and other files) in
  11 the wiki are mapped.
  12
  13 By default, the names of pages are shown in the map. Since ikiwiki 2.51,
  14 The `show` parameter
  15 can be used to show the titles or descriptions of pages instead (as set by
  16 the [[meta]] plugin). For example:
  17
  18         \[[map pages="* and !blog/* and !*/Discussion" show=title]]
  19
  20 Hint: To limit the map to displaying pages less than a certain level deep,
  21 use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
  22
  23 [[if test="enabled(map)" then="""
  24 Here's an example map, for the plugins section of this wiki:
  25
  26 [[map pages="(plugins or plugins/*) and !*/*/*"]]
  27 """]]