README.md
1# dokuwiki-plugin-minimap
2
3[](https://travis-ci.com/gerardnico/dokuwiki-plugin-minimap)
4
5## Usage
6
7The [Minimap Dokuwiki plugin](https://www.dokuwiki.org/plugin:minimap) generates a [sitemap](https://www.dokuwiki.org/index_sitemap?do=index) but only for the current [namespace](https://www.dokuwiki.org/namespaces) (ie mini-map)
8
9By adding the `<minimap>` tag in your page, you will generate a mini-map.
10
11See the mini-map plugin page on Dokuwiki [here](https://www.dokuwiki.org/plugin:minimap)
12
13## Example
14
15See the plugin in action [here](http://gerardnico.com/dokuwiki/minimap).
16
17## Illustration
18
19
20
21## Installation
22
23Install the plugin using:
24
25 * the [Plugin Manager](https://www.dokuwiki.org/plugin:plugin)
26 * [manually](https://www.dokuwiki.org/plugin:Plugins) with the [download URL](http://github.com/gerardnico/dokuwiki-plugin-minimap/zipball/master), which points to latest version of the plugin.
27
28
29## Syntax
30
31```xml
32<minimap suppress="regular expression pattern" includeDirectory="false" debug="false" showHeader="true" namespace="another:name:space">
33```
34
35where:
36
37 * the `suppress` option will suppress the "regular expression pattern" part of the page title. It uses the function [preg_replace](http://php.net/manual/en/function.preg-replace.php). Actually in the pattern, letters, digits and the following characters are allowed: space, -, _, |, *, .
38The use case is when you add to the title of your page already a namespace.
39 * the `includeDirectory` permits to include the subdirectories in the list (Default=false)
40 * the `showHeader` permits to see a header if there is no homepage found (Default=true)
41 * the `debug` parameter prints debug information if set to true below the panel header and in the link title (Default=false)
42 * the `namespace` parameter (default to the current namespace) may be used to change the namespace
43
44## Example
45
46```xml
47<minimap suppress="Dokuwiki - |The Doku - ">
48```
49
50With the following page title,
51```
52Dokuwiki - Plugin Mini Map
53The Doku - Syntax
54```
55The mini-map will show the following page title:
56```
57Plugin Mini Map
58Syntax
59```
60
61## Configuration and Settings
62
63### Toolbar Shortcut
64A button  is added in the toolbar, you can choose the shortcut key in the [configuration manager](https://www.dokuwiki.org/plugin:config).
65
66### Cache
67As this plugin has a lot of chance to be used in a [sidebar](https://www.dokuwiki.org/faq:sidebar), you may want to add a `~~NOCACHE~~` [macro](https://www.dokuwiki.org/wiki:syntax#control_macros)
68
69### Credits
70
71You can change the credits as you want as long as there is a link to the minibar plugin ie (https://gerardnico.com/dokuwiki/minimap)
72
73There is a configuration where you can change it to make it as small as a `M` for instance.
74
75## Support
76
77### No Home Page Found
78
79When the plugin can't find a start page, it will show in the head of the component `No Home Page Found`
80
81The start page of a namespace is:
82
83 * the last name of your namespace
84 * or the value of the [startpage configuration](https://www.dokuwiki.org/config:startpage) (by default `start`)
85
86For instance, for the namespace `wiki`, a start page would be:
87
88 * `wiki:wiki`
89 * or `wiki:start`
90
91
92You can also solve this problem with a configuration:
93
94 * If you don't have any home page, you can set the parameter `showHeader` to `false`
95```xml
96<minimap showHeader="false" >
97```
98 * If you have by default no homepage, you can set it globally in the configuration parameters.
99
100
101## Releases History
102 * 2020-06-02
103 * The regular expression was not strict for php 7.3 (See [pcre2-migration](https://wiki.php.net/rfc/pcre2-migration))
104 * The parameters `namespace` and `showheader` were added
105 * A `powered by` description was also added
106 * 2020-05-22
107 * The li were not enclosed in a ul - accessibility problem
108 * 2018-04-28
109 * The plugin is now Bootstrap 4 compatible. The icons were suppressed.
110 * 2017-4-29:
111 * The list item are working now with the mathjax plugin. The HTML tag were not encoded
112 * The list items have no a left margin of 0. It was overwritten by the standard dokuwiki template
113 * 2016-06-04:
114 * The `includeDirectory` option was added.
115 * 2015-12-28:
116 * The styling is now targeted only for the mini-map elements and will not interfere with the admin page. See [Issue 2](https://github.com/gerardnico/dokuwiki-plugin-minimap/issues/2).
117 * The handle function of the syntax class does not have any other variable instantiation than the one in the syntax.
118 * 2015-10-25:
119 * First Release.
120
121
){kind=link}
