Difference between revisions of "Reference:BlueSpiceCustomMenu"
(Tag: 2017 source edit) |
Extension: BlueSpiceCustomMenu
| Overview | |||
|---|---|---|---|
| Description: | Provides customizable menus | ||
| State: | stable | Dependency: | BlueSpice |
| Developer: | License: |
GPL v3 only-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process. |
|
| Type: | BlueSpice | Category: | Search and Navigation |
| Edition: | BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud | ||
Features
CustomMenu is a menu with configurable items.
It appears as collapsible menu above the top navigation bar. The HTML output is an unordered list.
Menu items can be modified by editing the page MediaWiki:CustomMenu/Header.
Syntax:
* html ID (has to be unique) | target page | label (optional)
The html ID can be used to apply CSS rules in MediaWiki:Common.css.
Examples:
1. A link to the Wiki page 'Intranet':
* menuLink1 | Intranet
The html ID 'menuLink1' is used to display the menu item, because no label has been specified.
2. A link to the Wiki page 'Intranet'. The visible label is 'Our Intranet':
* menuLink1 | Intranet | Our Intranet
3. A Dropdown with link to the Wiki pages 'Intranet' and 'Demo'. The visible label of the menu is 'Hello World'. The dropdown contains 'Our Intranet' and 'Demo':
* Hello World
** menuLink1 | Intranet | Our Intranet
** demoLink | https://en.demo.bluespice.com | Demo
Technical information[edit | edit source]
BlueSpiceCustomMenu will be hidden on mobile devices. The width is restricted to the content width. It is limited to one line.
By default, there are only 2 menu levels (link text and one dropdown). More levels can be set, but it is tested only up to level 3.
Further menus may be outside the browser window
| Name | Default value | Override by |
|---|---|---|
| $bsgCustomMenuHeaderNumberOfLevels | 2 | $bsgOverrideCustomMenuHeaderNumberOfLevels |
| $bsgCustomMenuHeaderNumberOfMainEntries | 10 | $bsgOverrideCustomMenuHeaderNumberOfMainEntries |
| $bsgCustomMenuHeaderNumberOfSubEntries | 10 | $bsgOverrideCustomMenuHeaderNumberOfSubEntries |
.
Technical Information[edit source]
This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.
Requirements[edit source]
- MediaWiki: 1.31
- BlueSpiceFoundation: 3.2
Configuration[edit source]
| Name | Value |
|---|---|
| CustomMenuHeaderNumberOfLevels | 2 |
| CustomMenuHeaderNumberOfMainEntries | 10 |
| CustomMenuHeaderNumberOfSubEntries | 10 |
Hooks[edit source]
{{BSExtensionInfoboxBSExtensionInfo
|desc=Provides customizable menus
|status=stable
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud
|active=No
|compatible=BlueSpice
|category=Search and Navigation
|license=GPL v3 only
}}|features=
'''CustomMenu''' is a menu with configurable items.
==Usage / features==
CustomMenu is implemented as header menu with flyout child menus. It appears as collapsible menu above the top navigation bar. The HTML output is an unordered list. CustomMenu is '''enabled by default'''.
Menu items can be modified by editing the page <code>MediaWiki:CustomMenu/Header</code>.
Syntax:
<pre>* html ID (has to be unique) | target page | label (optional)</pre>
The [https://www.w3schools.com/html/html_id.asp html ID] can be used to apply CSS rules in <code>MediaWiki:Common.css</code>.
'''Examples:'''
1. A link to the Wiki page 'Intranet':
<pre>* menuLink1 | Intranet</pre>
The html ID 'menuLink1' is used to display the menu item, because no label has been specified.
2. A link to the Wiki page 'Intranet'. The visible label is 'Our Intranet':
<pre>* menuLink1 | Intranet | Our Intranet</pre>
3. A Dropdown with link to the Wiki pages 'Intranet' and 'Demo'. The visible label of the menu is 'Hello World'. The dropdown contains 'Our Intranet' and 'Demo':
<pre>
* Hello World
** menuLink1 | Intranet | Our Intranet
** demoLink | https://en.demo.bluespice.com | Demo
</pre>
==Technical information==
BlueSpiceCustomMenu will be hidden on mobile devices. The width is restricted to the content width. It is limited to one line.
By default, there are only 2 menu levels (link text and one dropdown). More levels can be set, but it is tested only up to level 3. We recommend not to use more levels. Menu Further menus may be outside the browser window!
'''Config'''
{| class="wikitable"
!Name!!Default value!!Override by
|-
|$bsgCustomMenuHeaderNumberOfLevels||<nowiki>2</nowiki>||$bsgOverrideCustomMenuHeaderNumberOfLevels
|-
|$bsgCustomMenuHeaderNumberOfMainEntries||<nowiki>10</nowiki>||$bsgOverrideCustomMenuHeaderNumberOfMainEntries
|-
|$bsgCustomMenuHeaderNumberOfSubEntries||<nowiki>10</nowiki>||$bsgOverrideCustomMenuHeaderNumberOfSubEntries
|}
{{Translation}}
[[Category:Extension]]
[[Category:BlueSpice free]].
}}| Line 1: | Line 1: | ||
| − | {{ | + | {{BSExtensionInfo |
|desc=Provides customizable menus | |desc=Provides customizable menus | ||
|status=stable | |status=stable | ||
|type=BlueSpice | |type=BlueSpice | ||
|edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud | |edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud | ||
| − | |||
|compatible=BlueSpice | |compatible=BlueSpice | ||
|category=Search and Navigation | |category=Search and Navigation | ||
|license=GPL v3 only | |license=GPL v3 only | ||
| − | + | |features= | |
| − | '''CustomMenu''' is a menu with configurable items | + | '''CustomMenu''' is a menu with configurable items. It appears as collapsible menu above the top navigation bar. The HTML output is an unordered list. Menu items can be modified by editing the page <code>MediaWiki:CustomMenu/Header</code>. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | Menu items can be modified by editing the <code>MediaWiki:CustomMenu/Header</code>. | ||
Syntax: | Syntax: | ||
| Line 45: | Line 39: | ||
** demoLink | https://en.demo.bluespice.com | Demo | ** demoLink | https://en.demo.bluespice.com | Demo | ||
</pre> | </pre> | ||
| − | |||
BlueSpiceCustomMenu will be hidden on mobile devices. The width is restricted to the content width. It is limited to one line. | BlueSpiceCustomMenu will be hidden on mobile devices. The width is restricted to the content width. It is limited to one line. | ||
| − | By default, there are only 2 menu levels (link text and one dropdown). More levels can be set, but it is tested only up to level 3. | + | By default, there are only 2 menu levels (link text and one dropdown). More levels can be set, but it is tested only up to level 3.Further menus may be outside the browser window. |
| − | + | }} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||