diff options
author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:04:23 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:19 -0400 |
commit | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (patch) | |
tree | 725f523faeb8e8db0efd81be4024257799c93ef8 /underlays/basewiki/directive/map.mdwn | |
parent | 595b0359157d1f57ee5a87c63e665dfa1d2130ec (diff) |
add underlay files for listdirectives
As was noted, 'listdirectives' didn't include the underlay files that make
it really worthwhile. I've just gone through all the plugin
documentation, modified it to remove installation information and renamed
the files to match the directives rather than the plugins. This can now
serve as useful underlay.
I've only gone through plugins in the 'plugins' dir. I did not go through
the 'contrib' dir.
Diffstat (limited to 'underlays/basewiki/directive/map.mdwn')
-rw-r--r-- | underlays/basewiki/directive/map.mdwn | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/map.mdwn b/underlays/basewiki/directive/map.mdwn new file mode 100644 index 000000000..3b27416ef --- /dev/null +++ b/underlays/basewiki/directive/map.mdwn @@ -0,0 +1,17 @@ +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 !*/*/*"` |