Manual:Extension/MenuEditor

Introduction

The menu editor is used in various menus of the wiki ― for example in the main navigation ― to set up navigation links. An edit link appears at the end of each menu when you hover over the menu.

"Edit"-link of the menu editor

Alternatively you can also open the MediaWiki page corresponding to the navigation or menu to edit. If the page doesn't yet exist, a corresponding note will appear and you can create the page.

Seite MediaWiki:Sidebar anlegen.

Edit main navigation

If you have set the navigation type to MediaWiki Sidebar or Extended MediaWiki Sidebar on the main navigation , the navigation links are created using the menu editor.

Editing the default links

A new wiki already has some links created by default. These are displayed as system messages and reference pages with the same name in the MediaWiki namespace (to support the user languages). The entire menu or individual menu links can be deleted.

The default links in the "Getting started" menu

MediaWiki sidebar

A simple list of links to wiki pages (often to portal pages) and is the standard view of the sidebar. A hierarchical navigation structure is not supported. If you need a more flexible menu, switch to the Enhanced MediaWiki sidebar.

​If you have set "MediaWiki Sidebar" as the configuration, proceed as follows:

To add a new heading:

1. Click Add element.

   

   Add menu heading

2. Enter the text for the heading. Note: In a multilingual wiki, enter a system message here.

Text for menu heading

Add links:

1. Click on the hamburger menu next to the heading.
2. Select Add sub element.

   

   Add link as sub element

3. Enter the link target (page name) and the link designation (label).

   

   Create link

4. Click on Done.
5. Repeat steps 1-3.
6. Click Save.

Enhanced MediaWiki sidebar

This view shows a fully customizable multi-hierarchical menu.

Here, you edit the page MediaWiki:Sidebar.json. It has the basic functionality of the standard MediaWiki sidebar. In addition, it distinguishes between the following sub elements (=node types):

• Internal Link: Simply provide a link to a wiki page with an additional link label. Both the page name and/or label can be created by using a parser function.

  

  Internal link with a variable.

• External Link: Same as internal link, but you need to provide a full url to an external website.
• Subpage tree: You can provide the name of a page that has one or more levels of subpages. You can set the depth 6 levels deep. This means, that if you want to show the first level of subpages, you would select a depth of 1.

Creating a subpage tree with the Enhanced MenuEditor.

You cannot use the same link label twice for different subpage trees, because the expand/collapse functionality will break.

It is not possible to change the node type (=item type) after creating it. Instead, create a new item as needed and delete the unwanted item.

Show for groups

In addition, the visibility of a menu item can be limited to certain wiki groups. Enter a comma-separated list of existing wiki groups in the "Show for groups" field.

Css classes

You can also apply css classes to any item for custom styling options. The styles need to be defined on the page MediaWiki:Common.css.

Edit other menus

The following menus are also edited with the menu editor:

• Personal user menu
• Additional menu
• Footer menu

Visual editing mode

Click Edit to switch to edit mode.

​To add a new menu heading:

1. Click Add new element.
2. Enter the text for your menu header. In a multilingual wiki, you can also enter a message key.

Source editing mode

Click Edit source to switch to source edit mode.

Entries starting with a single star ("*") create menu headings or sections while entries with two stars ("**") create links.

* Bookmarks
** Wiki_Page1|Label
** https://externallink.com|Label

Related info

• Menu overview

Technical Reference: MenuEditor

PDF exclude - start

---

To submit feedback about this documentation, visit our community forum.

PDF exclude - end