diff options
| author | Joey Hess <joey@kodama.kitenet.net> | 2008-06-15 19:08:50 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-06-15 19:08:50 -0400 |
| commit | 4da54999de859c505c26ff2a0a23772939caeffa (patch) | |
| tree | 3744c3d9f44a3532333ee399de26352a3eafad8a /doc | |
| parent | ebb2b9cbda42eaff70f13303ad891c6f7aaddb33 (diff) | |
meta: Store "description" in pagestate for use by other plugins.
map: Support show=description.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins.mdwn | 2 | ||||
| -rw-r--r-- | doc/plugins/map.mdwn | 7 |
2 files changed, 7 insertions, 2 deletions
diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 439cecc8a..ca1dfd1ff 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,6 +1,8 @@ Most of ikiwiki's [[features]] are implemented as plugins. Many of these plugins are included with ikiwiki. +[[map pages="plugins/*" show=description]] + [[pagestats pages="plugins/type/* and !plugins/type/slow"]] There's documentation if you want to [[write]] your own plugins, or you can diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index d50c9b292..df34d77cd 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,6 +1,8 @@ [[template id=plugin name=map author="Alessandro Dotti Contra"]] [[tag type/meta]] +[[meta description="some page description"]] + This plugin generates a hierarchical page map for the wiki. Example usage: \[[map pages="* and !blog/* and !*/Discussion"]] @@ -9,8 +11,9 @@ 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 of pages instead. For example: - +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, |