2 Customizing the main navigation

Latest revision as of 13:01, 14 August 2024

The user interface provides 3 customizable menus: Main navigation, Custom menu, User menu. All of them can be edited with the menu editor.

Main navigation

The main navigation is displayed on all content pages in the wiki and does not change in individual namespaces.

Up to v.4.2, only the standard MediaWiki sidebar is available. By default, some links are provided as entry points to the wiki. Wiki administrators can deactivate these links in the configuration manager if needed. In addition, you can also add new links below the entrypoints (admin permissions required). Please note that no hierarchical links can be created. Therefore, it makes sense to mainly set up links to the most important topics and to portal pages that contain additional links or page lists.

Main navigation BlueSpice 4.4+
Main navigation BlueSpice -4.3

Menu types for the main navigation v4.3+

Starting at BlueSpice 4.3, four different menu settings are available. Administrators can select a menu type in the Config manager.

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 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 2.

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.

Custom menu

In BlueSpice 4, an additional custom menu is integrated as a mega menu. This menu can be created and edited by users with admin rights. The link-icon (1) is only displayed once the corresponding page has been created.

If you don't see the menu icon in your wiki, create the following page: MediaWiki:CustomMenu/Header

Custom menu: (1) open menu, (2) edit link, (3) menu items

Editing the custom menu

User menu

Users can customize their personal navigation menu. The mega menu can be opened by clicking on the profile picture in the top toolbar. The user menu consists of two sections: Customizable links and Personal tools. Only the customizable links can be edited.

user menu

By default, the menu shows the following information:

Pages visited (widget PAGESVISITED)
My edits (widget YOUREDITS)

These widgets can be removed individually when a user customizes the sidebar.

Editing the user menu

Technical Reference: MenuEditor

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

@@ Line 1: / Line 1: @@
-{{BSVersionHd|bsvFrom=4.3|bsvTo=}}
+<bookshelf src="Book:Admin manual" />
-== Menu types ==
+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.
-The user interface provides 3 customizable menus:
-# Main navigation
-# Custom menu
-# User menu
 == Main navigation ==
 The main navigation is displayed on all content pages in the wiki and does not change in individual namespaces.
-Up to v.4.2, only the standard [[Pagedraft:MenuEditor#MediaWiki sidebar|MediaWiki sidebar]] is available.
+Up to v.4.2, only the standard [[#MediaWiki sidebar|MediaWiki sidebar]] is available.{{#dpl:title=Manual:Extension/BlueSpiceDiscovery/Main navigation|include=#Overview}}
+=== 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]].
-=== BlueSpice 4.3 ===
+==== MediaWiki sidebar ====
-Starting BlueSpice 4.3, four different menu settings are available. Administrators can select a menu type in the [[Manual:Extension/BlueSpiceDiscovery|Config manager]].
+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]].
-All four types optionally show a list of pre-defined Entry points.
+{{RefLink|page=Manual:Extension/BlueSpiceCustomMenu#Visual_edit_mode|label=Editing the standard main navigation}}
-==== MediaWiki sidebar ====
+==== Namespace main page list====
-This is the standard view of the sidebar.  It displays custom menu items with no hierarchical structure.
-==== 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) ====
+==== 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 ====
+==== Enhanced MediaWiki sidebar====
-This view shows a fully customizable multi-hierarchical menu. It can consist of the following elements:
+This view shows a fully customizable multi-hierarchical menu. Here, you edit the page MediaWiki:Sidebar.json. It has the basic functionality of the [[#MediaWiki sidebar|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.<br />  [[File:EnhancedMenuEditor-internal link.png|alt=Internal link with a variable.|center|thumb|550x550px|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 <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 />
+[[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.
+=== 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 <code>MediaWiki:Common.css.</code>
 == Custom menu ==
-{{#dpl:title=Manual:Extension/BlueSpiceCustomMenu|include=#Overview}}
+{{#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}}