diff options
| author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
| commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
| tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/map.mdwn | |
| parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) | |
| download | ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar.gz | |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/map.mdwn')
| -rw-r--r-- | doc/plugins/map.mdwn | 23 |
1 files changed, 2 insertions, 21 deletions
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 9283eb4cf..f4dd91e48 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,24 +1,5 @@ [[!template id=plugin name=map author="Alessandro Dotti Contra"]] [[!tag type/meta]] -This plugin 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 !*/*/*"` - -[[!if test="enabled(map)" then=""" -Here's an example map, for the plugins section of this wiki: - -[[!map pages="(plugins or plugins/*) and !*/*/*"]] -"""]] +This plugin implements the [[ikiwiki/directive/map]] [[ikiwiki/directive]]. +The directive generates a hierarchical page map for the wiki. |