ikiwiki/doc/plugins/map.mdwn

[[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"]]

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 !*/*/*"]]
"""]]
simplified plugin definitions 2007-02-13 19:51:21 +01:00			`[[template id=plugin name=map author="Alessandro Dotti Contra"]]`
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin. 2006-08-23 07:41:07 +02:00			`[[tag type/meta]]`

meta: Store "description" in pagestate for use by other plugins. map: Support show=description. 2008-06-16 01:08:50 +02:00			`[[meta description="some page description"]]`

* Add a map plugin contributed by Alessandro Dotti Contra. 2006-08-18 18:18:45 +02:00			`This plugin generates a hierarchical page map for the wiki. Example usage:`

Change to new preprocessor syntax 2008-07-21 09:19:35 +02:00			`\[[!map pages="* and !blog/* and !*/Discussion"]]`
* Add a map plugin contributed by Alessandro Dotti Contra. 2006-08-18 18:18:45 +02:00
			`If the pages to include are not specified, all pages (and other files) in`
remove maxdepth, it can be accomplished by pagespec like ".. and !///" 2006-08-18 18:45:28 +02:00			`the wiki are mapped.`

remove note about version This wiki documents the current (actually, next ;-) release of ikiwiki. I don't want to have version numbers everywhere. (plugins/write is an exception to this policy). 2008-07-19 19:16:40 +02:00			By default, the names of pages are shown in the map. The `show` parameter
meta: Store "description" in pagestate for use by other plugins. map: Support show=description. 2008-06-16 01:08:50 +02:00			`can be used to show the titles or descriptions of pages instead (as set by`
			`the [[meta]] plugin). For example:`

Change to new preprocessor syntax 2008-07-21 09:19:35 +02:00			`\[[!map pages="* and !blog/* and !*/Discussion" show=title]]`
map: Add a "show" parameter. "show=title" can be used to display page titles, rather than the default page name. Based on a patch from Jaldhar H. Vyas, Closes: #484510 2008-06-15 22:11:11 +02:00
web commit by JonasSmedegaard: Fix typo 2007-10-06 22:24:36 +02:00			`Hint: To limit the map to displaying pages less than a certain level deep,`
MAJOR basewiki reorg Including redir pages for the moved basewiki pages. These will be removed in a future release. 2007-12-08 21:59:08 +01:00			use a [[ikiwiki/PageSpec]] like this: `pages="* and !//*"`
* Add a map plugin contributed by Alessandro Dotti Contra. 2006-08-18 18:18:45 +02:00
* Allow plugins to add new types of tests that can be used in PageSpecs. * Add a "conditional" plugin, which allows displaying text if a condition is true. It is enabled by default so conditional can be used in the basewiki. * Use conditionals in the template for plugins, so that plugin pages say if they're currently enabled or not, and in various other places in the wiki. 2007-02-12 03:44:47 +01:00			`[[if test="enabled(map)" then="""`
			`Here's an example map, for the plugins section of this wiki:`
* Add a map plugin contributed by Alessandro Dotti Contra. 2006-08-18 18:18:45 +02:00
Change to new preprocessor syntax 2008-07-21 09:19:35 +02:00			`[[!map pages="(plugins or plugins/) and !//"]]`
* Allow plugins to add new types of tests that can be used in PageSpecs. * Add a "conditional" plugin, which allows displaying text if a condition is true. It is enabled by default so conditional can be used in the basewiki. * Use conditionals in the template for plugins, so that plugin pages say if they're currently enabled or not, and in various other places in the wiki. 2007-02-12 03:44:47 +01:00			`"""]]`