Manual:Extension/BlueSpiceDiscovery/Main navigation: Difference between revisions

Latest revision as of 10:11, 21 May 2025

Overview

The main navigation is the main (left) sidebar in the desktop view of the wiki. The contents of this navigation bar apply to the entire wiki and cannot be created for specific namespaces.

Links can be added to this navigation. To keep the main navigation from becoming too extensive, it's a good idea to add links to the most important topics and to related portal pages.

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.

Deactivating entrypoint links

In a new wiki, some standard links are displayed under the heading "Entrypoints." These may vary depending on the BlueSpice version and can be enabled or disabled via the configuration manager menu item Skinning.

Choosing a menu type for the main navigation

In the configuration manager, you can choose between four menu settings:

MediaWiki sidebar: A simple list of links to wiki pages (often to portal pages). A hierarchical navigation structure is not supported.
Namespace main page list: Automatically creates links to all pages in the wiki using the syntax namespace prefix:mainpage (e.g., QM:mainpage).
Subpage tree: Useful in a wiki that primarily structures pages using subpages.
Enhanced MediaWiki sidebar: A list of links to wiki pages. A hierarchical navigation structure is supported. Pages can be displayed with their subpage structure expanded.

Editing the main navigation

If you have set your navigation type to MediaWiki Sidebar or Extended MediaWiki Sidebar, your custom navigation links are created using the menu editor. A new wiki installation may already have some links created. You can delete these using the menu editor.

View instructions on the menu editor help page.

Related info

PDF exclude - start

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

PDF exclude - end

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Main navigation}}
-<bookshelf src="Book:Admin manual" />
+==Overview==
-==How does the main navigation work?==
+The main navigation is the main (left) sidebar in the desktop view of the wiki. The contents of this navigation bar apply to the entire wiki and cannot be created for specific [[Manual:The concept of namespaces|namespaces]].
-By default, some links are provided as entry points to the wiki. Wiki administrators can deactivate these links in the [[Manual:Extension/BlueSpiceConfigManager|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.
-[[File:Manual:skin-discovery-hauptnavigation-EN.png|alt=Main navigation|center|thumb|402x402px|Main navigation]]
-==Visual edit mode (menu editor)==
+Links can be added to this navigation. To keep the main navigation from becoming too extensive, it's a good idea to add links to the most important topics and to related [[Manual:Startpage templates|portal pages]].
-{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=Visual menu editor}}
-'''To add a new menu header using the menu editor:'''
-#'''Click''' ''edit sidebar'' at the bottom of the navigation menu. the page ''MediaWiki:Sidebar'' from the browser address bar. If the page does not exist yet, you will see a notice on the page.[[Datei:Handbuch:sidebar-anlegen.png|alternativtext=Seite MediaWiki:Sidebar anlegen|zentriert|mini|650x650px|Seite ''MediaWiki:Sidebar'' anlegen: (1) Meldung, (2) Bearbeiten-Schaltfläche]]
-#'''Click''' ''Add new element'' to create a new menu header.
-#. [[Datei:Handbuch:sidebar-neues stammelement.png|alternativtext=Neues Stammelement|zentriert|mini|650x650px|Neues Stammelement]]
-#'''Enter''' the text for your menu header. In a multilingual wiki, you can also enter a [[mediawikiwiki:Help:System_message|message key]].  [[Datei:Handbuch:sidebar-stammelement-dialog.png|alternativtext=Text eingeben|zentriert|mini|650x650px|Text eingeben]]
-#
+By default, some links are provided as entry points to the wiki. Wiki administrators can deactivate these links in the [[Manual:Extension/BlueSpiceConfigManager|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.
-'''To add links:'''
+[[File:Manual:main_nav_4-4.png|alt=Entry links and custom links|center|thumb|368x368px|Main navigation]]
-#'''Select''' ''Add new subitem''  from the dropdown menu of the menu header.[[File:Main navigation 1667828722138.png|alt=add a link|none|thumb|add a link as a new subitem]]
-#Enter the page name as the link target and the label that you want to show:[[File:Main navigation 1667828849101.png|alt=enter link info|none|thumb|enter link info]]
-#'''Click''' ''Done.''
-#'''Repeat''' steps 1-3.
-#'''Click''' ''Save changes''.
-{{Messagebox|boxtype=note|icon=|Note text=If you use the parser function <code><nowiki>{{#ifingroup:...</nowiki> </code> to display navigation elements in the source code, you must always edit the main navigation in the source code. In visual editing mode, saving removes any parser function or semantic queries.|bgcolor=}}
-#
-<span><span /><span /><br /></span> '''To add new links:'''
-#'''Click'''  ''edit sidebar'' below the navigation links.
-#'''Change''' to source editing mode.
-#'''Create''' one or more navigation links (with or without section heading).  The following example shows a link to the page "Company" with the label "Our company" and an external link to the BlueSpice website with the label "Website". The links are grouped together under the section heading "Quicklinks":<syntaxhighlight lang="text">
-*Quicklinks
-**Company|Our company
-**https//www.bluespice.com/de|Website
-</syntaxhighlight>
-#'''Save''' the page. The links are now shown in the main navigation.
-{{Messagebox|boxtype=note|icon=|Note text=As soon as you have created at least one additional link, a direct edit link to the ''MediaWiki:Sidebar'' page is displayed when you move the mouse over such a link (see screenshot above).|bgcolor=}}
-<span class="ve-pasteProtect">Link labels may collide with system messages. If this is the case, simply append the HTML-code for an empty space to the description:</span><syntaxhighlight lang="text">
-**Portal|Portal&#160;
-</syntaxhighlight>
-==Deactivating standard links==
-The standard links can be deactivated in the  [[Manual:Extension/BlueSpiceConfigManager|configuration manager]]. The following settings are available under ''Feature > Skinning'':
-<span><span /><span /><br /></span>
-BlueSpiceBookshelf:
-*Show entrypoint "Bookshelf"
-BlueSpiceDiscovery:
-*Show entrypoint "Mainpage"
-*Show entrypoint "All pages"
-*Show entrypoint "Recent changes"
-BlueSpiceSocial:
-*Show entrypoint "Timeline"
-BlueSpiceSocialBlog:
+== Deactivating entrypoint links ==
+In a new wiki, some standard links are displayed under the heading "Entrypoints." These may vary depending on the BlueSpice version and can be enabled or disabled via the [[Manual:Extension/BlueSpiceConfigManager|configuration manager]] menu item ''Skinning.''
-*Show entrypoint "Blog"
+== Choosing a menu type for the main navigation ==
+In the configuration manager, you can choose between four menu settings:
-==Group-specific navigation==
+# [[Manual:Extension/BlueSpiceDiscovery/Main navigation#MediaWiki sidebar|MediaWiki sidebar]]: A simple list of links to wiki pages (often to portal pages). A hierarchical navigation structure is not supported.
-<span style="color: rgb(51, 51, 51)">It is possible to show navigation elements for specific user groups only. Please note that the pipe symbol (|) between the page name and its label has to be escaped as</span> <code><nowiki>{{!}}</nowiki></code> <span style="color: rgb(51, 51, 51)">within this function.</span>
+# Namespace main page list: Automatically creates links to all pages in the wiki using the syntax namespace prefix:mainpage (e.g., QM:mainpage).
+# Subpage tree: Useful in a wiki that primarily structures pages using subpages.
+# [[Manual:Extension/BlueSpiceDiscovery/Main navigation#Enhanced MediaWiki sidebar|Enhanced MediaWiki sidebar]]: A list of links to wiki pages. A hierarchical navigation structure is supported. Pages can be displayed with their subpage structure expanded.
-This syntax is defined in the extension [[Reference:UserFunctions|UserFunctions]].<syntaxhighlight lang="text">
+== Editing the main navigation ==
-{{#ifingroup:sysop,widgeteditor |
+If you have set your navigation type to ''MediaWiki Sidebar'' or ''Extended MediaWiki Sidebar'', your custom navigation links are created using the menu editor. A new wiki installation may already have some links created. You can delete these using the menu editor.
-*Test2
+[[File:Main navigation Getting started.png|alt=Getting Started menu with four default links|center|thumb|200x200px|Standard custom links in the main navigation]]
-**somepage{{!}}Some page
-|}}
-</syntaxhighlight>
-==Additional customizations==
-*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Icons|Display icons with navigation links]]
+[[Manual:Extension/MenuEditor|View instructions on the menu editor help page.]]
-*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Language support|Multi-language navigation]]
-<span /><span /><span /><br />
+{{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Long link labels|Alignment for navigation with long link labels]]|Topic2=[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Icons|Display icons with navigation links]]|Topic3=[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Language support|Multi-language navigation]]}}
 [[Category:Administration]]
 [[Category:Customization]]
-[[en:{{FULLPAGENAME}}]]
 [[de:Handbuch:Erweiterung/BlueSpiceDiscovery/Hauptnavigation anpassen]]