diff options
Diffstat (limited to 'doc/plugins/map.mdwn')
| -rw-r--r-- | doc/plugins/map.mdwn | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn new file mode 100644 index 000000000..039ed559e --- /dev/null +++ b/doc/plugins/map.mdwn @@ -0,0 +1,16 @@ +This plugin generates a hierarchical page map for the wiki. Example usage: + + \[[map pages="* and !blog/*" maxdepth=2]] + +If the pages to include are not specified, all pages (and other files) in +the wiki are mapped. If the maxdepth parameter is passed, only pages nested +less than that many levels deep will be included in the map. + +This plugin is included in ikiwiki, but is not enabled by default. + +If this plugin is enabled, here is a page map for the plugins section +of this wiki: + +[[map pages="plugins or plugins/*" maxdepth=3]] + +[[tag type/meta]] |