Manual:Extension/BlueSpiceCustomMenu and Manual:Extension/BlueSpiceDiscovery/Main navigation: Difference between pages

Revision as of 15:48, 3 March 2023

How does the main navigation work?

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

Visual edit mode (menu editor)

Visual menu editor is available from BlueSpice 4.2.

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.
Click Add new element to create a new menu header.
Enter the text for your menu header. In a multilingual wiki, you can also enter a message key.

To add links:

Select Add new subitem from the dropdown menu of the menu header.

add a link as a new subitem
Enter the page name as the link target and the label that you want to show:

enter link info
Click Done.
Repeat steps 1-3.
Click Save changes.

Note:If you use the parser function {{#ifingroup:... 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.

Adding links in source editing mode

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":
```
*Quicklinks
**Company|Our company
**https//www.bluespice.com/de|Website
```
Save the page. The links are now shown in the main navigation.

Link labels may collide with system messages. If this is the case, simply append the HTML-code for an empty space to the description:

**Portal|Portal&#160;

Deactivating standard links

The standard links can be deactivated in the configuration manager. The following settings are available under Feature > Skinning:

BlueSpiceBookshelf:

Show entrypoint "Bookshelf"

BlueSpiceDiscovery:

Show entrypoint "Mainpage"
Show entrypoint "All pages"
Show entrypoint "Recent changes"

BlueSpiceSocial:

Show entrypoint "Timeline"

BlueSpiceSocialBlog:

Show entrypoint "Blog"

Group-specific navigation

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 {{!}} within this function.

This syntax is defined in the extension UserFunctions.

{{#ifingroup:sysop,widgeteditor |
*Test2                       
**somepage{{!}}Some page
|}}

Additional customizations

Technical Reference: BlueSpiceCustomMenu

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

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:Custom menu}}
+{{DISPLAYTITLE:Main navigation}}
-==Overview==
+<bookshelf src="Book:Admin manual" />
-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.
+==How does the main navigation work?==
+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]]
-If you don't see the menu icon in your wiki, create the following page: <span style="color: rgb(37, 37, 37); font-family: monospace, Courier; font-size: 13.125px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(233, 233, 238); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; display: inline !important; float: none;">MediaWiki:CustomMenu/Header</span>
+==Visual edit mode (menu editor)==
+{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=Visual menu editor}}
+'''To add a new menu header using the menu editor:'''
-[[File:Manual:customMenu-view-EN.png|alt=Custom menu screenshot|center|thumb|750x750px|Custom menu: (1) open menu, (2) edit link, (3) menu items]]
+#'''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.
+#'''Click''' ''Add new element'' to create a new menu header.
+#'''Enter''' the text for your menu header. In a multilingual wiki, you can also enter a [[mediawikiwiki:Help:System_message|message key]].
-==Visual edit mode==
+<span><span /><span /><br /></span>
-{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=Visual menu editor}}
+<section begin="menulinks" />
+'''To add links:'''
+#'''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=}}
+<section end="menulinks" />
+== Adding links in source editing mode ==
+#
+<span><span /><span /><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.
+<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 /><span /><span /><span /><br /></span>
+BlueSpiceBookshelf:
+*Show entrypoint "Bookshelf"
-After creating the necessary page, you can now edit the menu.
+BlueSpiceDiscovery:
-'''Click''' ''Edit menu'' (2) to switch to edit mode.
+*Show entrypoint "Mainpage"
+*Show entrypoint "All pages"
+*Show entrypoint "Recent changes"
-If you are just starting out with the custom menu, you can start by editing the default ''Nav Menu'' item.
+BlueSpiceSocial:
-[[File:BlueSpiceCustomMenu navmenu item.png|alt=editing interface|center|thumb|'''editing interface:''' menu header (1), edit header name (2), add link to heading (3), add new menu header (4)]]
+*Show entrypoint "Timeline"
-'''To  edit the NavMenu item:'''
+BlueSpiceSocialBlog:
-#'''Click''' the icon for opening the edit dialog. (1)
+* Show entrypoint "Blog"
-#'''Click''' ''Edit Node.''
-#'''Enter''' the text for your menu header. In a multilingual wiki, you can also enter a [[mediawikiwiki:Help:System_message|message key]].
-{{#dpl: title=Manual:Extension/BlueSpiceDiscovery/Main_navigation|include=menulinks}}
+==Group-specific navigation==
+<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>
-== <span class="mw-headline">Adding links in source editing mode</span> ==
+This syntax is defined in the extension [[Reference:UserFunctions|UserFunctions]].<syntaxhighlight lang="text">
-'''To create a menu header:'''
+{{#ifingroup:sysop,widgeteditor |
-#'''Create''' the first menu header. Menu headers are marked with a single asterisk (*);<syntaxhighlight lang="text">
+*Test2
-* Important pages
+**somepage{{!}}Some page
+|}}
 </syntaxhighlight>
-#'''Add''' the links for this menu header. Links are marked with two asterisks (**) and have the following syntax:<syntaxhighlight lang="text">
-** target page|label
+==Additional customizations ==
-</syntaxhighlight>
-'''Example:'''<pre>* Important pages
+*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Long link labels|Alignment for navigation with long link labels]]
-** Special:Blog|Blog
+*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Icons|Display icons with navigation links]]
-** IMS:Policies|Policies
+*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Language support|Multi-language navigation]]
-* BlueSpice
-** https://bluespice.com|BlueSpice Homepage
+<span /><span /><span /><span /><span /><span /><br />
-** https://bluespice.com/category/news-know-how|News</pre>
+[[Category:Administration]]
-After the custom menu has been created, it can now be modified directly via the ''Edit menu'' link (see screenshot above).
-==Delete the custom menu==
-To remove the custom menu link-icon from the wiki, the <code>MediaWiki:CustomMenu/Header</code> page must be deleted. The page can be restored via the deletion log.
-{{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceDiscovery/Main_navigation|Customize the main navigation]]|Topic2=[[Manual:Extension/BlueSpiceUserSidebar|Customize the user menu]]|Topic3=[[Reference:BlueSpiceCustomMenu]]}}
-{{Translation}}
 [[Category:Customization]]
+[[en:{{FULLPAGENAME}}]]
+[[de:Handbuch:Erweiterung/BlueSpiceDiscovery/Hauptnavigation anpassen]]