2 Customizing the main navigation

Latest revision as of 07:19, 4 June 2025

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 focus on the menu.

Editing the main navigation

View the general introduction to the main navigation.

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

To open the menu editor:

Click Edit sidebar at the end of the navigation links. This link will become visible when you hover over existing links. If the page doesn't yet exist, a corresponding note will appear and you can create the page.

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.

MediaWiki sidebar

This is the standard view of the sidebar. It displays custom menu items with no hierarchical structure. If you need a more flexible menu, switch to the Enhanced MediaWiki sidebar.

Editing the standard main navigation

Namespace main page list

This view automatically displays the Main Page of each content namespace.

No combination with other menu elements is possible.

Subpage tree (context-sensitive)

This view automatically shows the subpages of a page if that page has subpages. Multi-level subpages are supported.

No combination with other menu elements is possible.

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.

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.

Technical Reference: MenuEditor

PDF exclude - start

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

PDF exclude - end

@@ Line 1: / Line 1: @@
-<bookshelf src="Book:Admin manual" />
+== 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 focus on the menu.
-The user interface provides 3 customizable menus: [[#Main navigation|Main navigation,]] [[#Custom menu|Custom menu]], [[#User menu|User menu.]] All of them can be edited with the menu editor.
+[[File:MenuEditor edit link.png|alt=menu items and activated edit link of the main navigation|center|thumb|201x201px|"Edit"-link of the menu editor]]
-== Main navigation ==
+== Editing the main navigation ==
-The main navigation is displayed on all content pages in the wiki and does not change in individual namespaces.
+[[Manual:Extension/BlueSpiceDiscovery|View the general introduction to the main navigation.]]
-Up to v.4.2, only the standard [[#MediaWiki sidebar|MediaWiki sidebar]] is available.{{#dpl:title=Manual:Extension/BlueSpiceDiscovery/Main navigation|include=#Overview}}{{RefLink|page=Manual:Extension/BlueSpiceCustomMenu#Visual_edit_mode|label=Editing the main navigation (v.4.1-4.2)}}
+If you have set the navigation type to ''MediaWiki Sidebar'' or ''Extended MediaWiki Sidebar'', the navigation links are created using the menu editor.
-=== Menu types for the main navigation{{Bsvs|bsvFrom=4.3|bsvTo=|bsvFeature=}}===
-Starting at BlueSpice 4.3, four different menu settings are available. Administrators can select a menu type in the [[Manual:Extension/BlueSpiceDiscovery|Config manager]].
+'''To open the menu editor:'''
+# '''Click''' ''Edit sidebar'' at the end of the navigation links. This link will become visible when you hover over existing links. If the page doesn't yet exist, a corresponding note will appear and you can create the page.
+[[File:menuEditor menu does not exist.png|alt=Note for the initial creation of the sidebar page|center|thumb|650x650px|Seite ''MediaWiki:Sidebar'' anlegen.]]
+=== 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.
+[[File:MenuEditor getting started links.png|alt=View of the standard links system messages in edit mode|center|thumb|650x650px|The default links in the "Getting started" menu]]
 ==== MediaWiki sidebar ====
 This is the standard view of the sidebar.  It displays custom menu items with no hierarchical structure. If you need a more flexible menu, switch to the [[#Enhanced MediaWiki sidebar|Enhanced MediaWiki sidebar]].
-{{RefLink|page=Manual:Extension/BlueSpiceDiscovery/Main_navigation|label=Editing the standard main navigation}}
+{{RefLink|page=Manual:Extension/BlueSpiceCustomMenu#Visual_edit_mode|label=Editing the standard main navigation}}
 ==== Namespace main page list====
@@ Line 34: / Line 43: @@
 ** 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 <code>6</code> levels deep with the parent page being the first level. This means, that if you want to show the first level of subpages, you would select a depth of <code>2</code>.<br />
+** You can provide the name of a page that has one or more levels of subpages. You can set the depth <code>6</code> levels deep. This means, that if you want to show the first level of subpages, you would select a depth of <code>1</code>.<br />
-[[File:EnhancedMenuEditor-subpage tree.png|alt=Screenshot of the edit window for a subpage tree item.|center|thumb|550x550px|Creating a subpage tree with the Enhanced MenuEditor.]]
+[[File:EnhancedMenuEditor-subpage tree.png|alt=Screenshot of the edit window for a subpage tree item.|center|thumb|550x550px|Creating a subpage tree with the Enhanced MenuEditor.]]{{Textbox|boxtype=important|header=|text=You cannot use the same link label twice for different subpage trees, because the expand/collapse functionality will break.|icon=yes}}
 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.
@@ Line 43: / Line 52: @@
 === Css classes ===
-You can also apply css classes to any item for custom styling options. The styles need to be defined on the page <code>MediaWiki:Common.css.</code>
+You can also apply css classes to any item for custom styling options. The styles need to be defined on the page <code>MediaWiki:Common.css.</code>{{translation}}
-== Custom menu ==
-{{#dpl:title=Manual:Extension/BlueSpiceCustomMenu|include=#Overview}}{{RefLink|page=Manual:Extension/BlueSpiceCustomMenu#Visual_edit_mode|label=Editing the custom menu}}
-== User menu ==
-{{#dpl:title=Manual:Extension/BlueSpiceUserSideBar|include=#Overview}}
-{{RefLink|page=Manual:Extension/BlueSpiceUserSideBar#Visual_edit_mode|label=Editing the user menu}}
-{{translation}}