X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/63edea27bc71c3bdf1837f994fb7effdd93fb2dd..28c3e5482d7431b7554e6288bb2f9f55fbd274ed:/doc/plugins/map.mdwn?ds=sidebyside diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index cd2ef1bc5..5b009f424 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,19 +1,19 @@ -This plugin generates a hierarchical page map for the wiki. Example usage: +[[!template id=plugin name=map author="Alessandro Dotti Contra"]] +[[!tag type/meta type/widget]] - \[[map pages="* and !blog/* and !*/Discussion"]] +This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]], +which generates a hierarchical page map for the wiki. -If the pages to include are not specified, all pages (and other files) in -the wiki are mapped. +[[!if test="enabled(map)" then=""" +This will create an a map, for the plugins section of this wiki: -Hint: To limit the map to displaying pages less than a certian level deep, -use a [[PageSpec]] like this: `pages="* and !*/*/*"` + \[[!map pages="(plugins or plugins/*) and !*/*/*"]] -This plugin is included in ikiwiki, but is not enabled by default. -It was contributed by Alessandro Dotti Contra. +Example: -If this plugin is enabled, here is a page map for the plugins section -of this wiki: +[[!map pages="(plugins or plugins/*) and !*/*/*"]] -[[map pages="(plugins or plugins/*) and !*/*/*"]] +It's also possible to search for specific tags or links: -[[tag type/meta]] + \[[!map pages="todo/* and !todo/done and !link(todo/done)"]] +"""]]