DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:menuext

This is an old revision of the document!


MenuExt Plugin

Compatible with DokuWiki

  • 2020-07-29 "Hogfather" yes
  • 2018-04-22 "Greebo" unknown
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown

plugin Add arbitrary links in DokuWiki menus

Last updated on
2021-07-13
Provides
Action
Repository
Source

Tagged with menu

This plugin allows Wiki administrators to add arbitrary links into DokuWiki's Menus by editing a simple configuration file.

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Configuration

To make use of the plugin, you need to create a conf/menuext.json file. Here's the example that comes with the plugin:

conf/menuext.json
{
    "page": [
        {
            "order": 3,
            "label": {
                "en": "Google Search",
                "de": "Google Suche"
            },
            "title": {
                "en": "Execute a Google search on the current page ID",
                "de": "Führe eine Google Suche mit der aktuellen Seiten-ID aus"
            },
            "link": "https://www.google.com/search?q=@ID@",
            "svg": "google.svg",
            "attr": {
                "target": "_blank"
            }
        }
    ]
}

As you can see, it's a nested structure configuring the menu items. The top level defines the menu to add to (see Available Menus) For each you can define the items to add.

order Position to add this item (starts at 0). Defaults to -2 to add at the end, before the back to top button
label The label to show on the menu item. One entry per language.
title The titel to show on mouseover. One entry per language.
link The link to use when clicking the item, can contain Replacement Patterns
svg The SVG icon to use. Can be a media ID, an absolute file name or a icon from materialdesignicons.com (auto downloaded from the latter)
attr additional attributes to set on the A node in HTML
plugin/menuext.1626165835.txt.gz · Last modified: 2021-07-13 10:43 by andi