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

Latest revision as of 14:31, 24 September 2024

Overview

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

Editing the main navigation

To open the menu editor:

Click Edit sidebar at the bottom of the navigation menu. If the page does not exist yet, you will see a notice on the page.

Menu editor

Visual menu editor is available from BlueSpice 4.2.

To add a new menu header using the menu editor:

Click Add new element to create a new menu header.

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

Enter a heading name
Click Done.

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.

Source edit mode

To add new 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;

Subpage tree

You can specify the name of a page that has one or more sub-page levels. You can set the depth to 6 levels, with the parent page being the first level. This means that if you want to display the first level of the subpages, you would choose a depth of 2.

It is not possible to use the same label multiple times in different subpage trees, as this will break the display of the subpages.

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

Visibility for groups

You can also restrict the visibility of a menu item to specific 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 element to get custom style options. The styles must be defined in MediaWiki:Common.css (knowledge of CSS required).

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
|}}

Note:Anytime the page is saved using the visual menu editor, the parser function will be overwritten and no longer works!

Additional customizations

Related info

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

@@ Line 1: / Line 1: @@
+{{DISPLAYTITLE:Main navigation}}
 <bookshelf src="Book:Admin manual" />
-==How does the main navigation work?==
+==Overview==
-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, custom links can be added here. 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.
+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]]
-==Adding links==
+<gallery widths="250" heights="350">
+File:Manual:main nav 4-4.png|Main navigation BlueSpice 4.4+
+File:Manual:skin-discovery-hauptnavigation-EN.png|Main navigation BlueSpice -4.3
+</gallery>
+== Editing the main navigation ==
+'''To open the menu editor:'''
+# '''Click''' E''dit sidebar'' at the bottom of the navigation menu. If the page does not exist yet, you will see a notice on the page.
+===Menu editor===
+{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=Visual menu editor}}
+'''To add a new menu header using the menu editor:'''
+#'''Click''' ''Add new element'' to create a new menu header.[[File:Main navigation add element.png|alt=Add a new menu heading|center|thumb|200x200px|Add a new menu heading]]
+#'''Enter''' the text for your menu header. In a multilingual wiki, you can also enter a [[mediawikiwiki:Help:System_message|message key]].[[File:Main navigation edit element.png|alt=Enter a heading name|center|thumb|450x450px|Enter a heading name]]
+#'''Click''' Done.
+'''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=}}
+=== Source edit mode ===
 '''To add new links:'''
-#'''Open''' the page ''MediaWiki:Sidebar'' from the browser's address bar.
+#'''Change''' to source editing mode.
-#'''Change''' to edit 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
@@ Line 18: / Line 44: @@
 #'''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 style="color: rgb(51, 51, 51)">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">
+<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>
-==Deacivating standard links==
+=== Subpage tree ===
+You can specify the name of a page that has one or more sub-page levels. You can set the depth to 6 levels, with the parent page being the first level. This means that if you want to display the first level of the subpages, you would choose a depth of 2.
+{{Textbox|boxtype=important|header=|text=It is not possible to use the same label multiple times in different subpage trees, as this will break the display of the subpages.|icon=yes}}
+It is not possible to change the node type (=element type) after creation. Instead, create a new element as needed and delete the unwanted element.
+==== Visibility for groups ====
+You can also restrict the visibility of a menu item to specific 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 element to get custom style options. The styles must be defined in  ''MediaWiki:Common.css'' (knowledge of CSS required).
+==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"
+*Show entrypoint "Bookshelf"
 BlueSpiceDiscovery:
@@ Line 42: / Line 82: @@
 BlueSpiceSocialBlog:
-*Show entrypoint "Blog"
+* Show entrypoint "Blog"
 ==Group-specific navigation==
@@ Line 48: / Line 88: @@
 This syntax is defined in the extension [[Reference:UserFunctions|UserFunctions]].<syntaxhighlight lang="text">
-{#ifingroup:sysop,widgeteditor |
+{{#ifingroup:sysop,widgeteditor |
 *Test2
 **somepage{{!}}Some page
 |}}
-</syntaxhighlight>
+</syntaxhighlight>{{Messagebox|boxtype=note|icon=|Note text=Anytime the page is saved using the visual menu editor, the parser function will be overwritten and no longer works!|bgcolor=}}
-==Additional customizations==
+==Additional customizations ==
+*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Long link labels|Alignment for navigation with long link labels]]
 *[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Icons|Display icons with navigation links]]
 *[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Language support|Multi-language navigation]]
-<br />
+{{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceCustomMenu|Custom menu]]|Topic2=[[Manual:Extension/BlueSpiceUserSidebar|User menu]]}}
 [[Category:Administration]]
 [[Category:Customization]]