dokuwiki-plugin-minimap

This is a fork of the meanwhile archived Minimap Dokuwiki plugin, which was thankfully build by Nickeau. By adding the <minimap> tag in your page, you will generate a sitemap for the current namespace.

Syntax

<minimap suppress="regular expression pattern" includeDirectory="false" debug="false" showHeader="true" namespace="another:name:space">

where:

• the suppress option will suppress the "regular expression pattern" part of the page title. It uses the function preg_replace. Actually in the pattern, letters, digits and the following characters are allowed: space, -, _, |, *, . The use case is when you add to the title of your page already a namespace.
• the includeDirectory permits to include the subdirectories in the list (Default=false)
• the showHeader permits to see a header if there is no homepage found (Default=true)
• the debug parameter prints debug information if set to true below the panel header and in the link title (Default=false)
• the namespace parameter (default to the current namespace) may be used to change the namespace

Example

<minimap suppress="Dokuwiki - |The Doku - ">

With the following page title,

Dokuwiki - Plugin Mini Map
The Doku - Syntax

The mini-map will show the following page title:

Plugin Mini Map
Syntax

Configuration and Settings

Toolbar Shortcut

A button is added in the toolbar, you can choose the shortcut key in the configuration manager.

Cache

As this plugin has a lot of chance to be used in a sidebar, you may want to add a ~~NOCACHE~~ macro

Credits

You can change the credits as you want as long as there is a link to the minibar plugin ie (https://gerardnico.com/dokuwiki/minimap)

There is a configuration where you can change it to make it as small as a M for instance.

Support

No Home Page Found

When the plugin can't find a start page, it will show in the head of the component No Home Page Found

The start page of a namespace is:

• the last name of your namespace
• or the value of the startpage configuration (by default start)

For instance, for the namespace wiki, a start page would be:

• wiki:wiki
• or wiki:start

You can also solve this problem with a configuration:

• If you don't have any home page, you can set the parameter showHeader to false

<minimap showHeader="false" >

• If you have by default no homepage, you can set it globally in the configuration parameters.

Releases History

• 2020-06-02
  • The regular expression was not strict for php 7.3 (See pcre2-migration)
  • The parameters namespace and showheader were added
  • A powered by description was also added
• 2020-05-22
  • The li were not enclosed in a ul - accessibility problem
• 2018-04-28
  • The plugin is now Bootstrap 4 compatible. The icons were suppressed.
• 2017-4-29:
  • The list item are working now with the mathjax plugin. The HTML tag were not encoded
  • The list items have no a left margin of 0. It was overwritten by the standard dokuwiki template
• 2016-06-04:
  • The includeDirectory option was added.
• 2015-12-28:
  • The styling is now targeted only for the mini-map elements and will not interfere with the admin page. See Issue 2.
  • The handle function of the syntax class does not have any other variable instantiation than the one in the syntax.
• 2015-10-25:
  • First Release.