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