Difference between revisions of "Reference:BlueSpiceCustomMenu"
(Tag: 2017 source edit) |
(Tag: Visual edit) |
Extension: BlueSpiceCustomMenu
| Overview | |||
|---|---|---|---|
| Description: | Provides customizable menus | ||
| State: | stable | Dependency: | BlueSpice |
| Developer: | License: | GPL v3 only | |
| Type: | Category: | - | |
| Edition: | BlueSpice free | ||
Features[edit source]
Description[edit | edit source]
BlueSpiceCustomMenu is a menu with configurable items.
Preferences[edit | edit source]
The BlueSpiceCustomMenu is implemented as header menu. It will appear as collapsible menu above the top navigation bar. The HTML output is an unordered list.
Usage/Features[edit | edit source]
The extension BlueSpiceCustomMenu is disabled enabled by default.
Menu items can be modified by editing the 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. We recommend not to use more levels. Menu may be outside the window!
Config
| Name | Default value | Override by |
|---|---|---|
| $bsgCustomMenuHeaderNumberOfLevels | 2 | $bsgOverrideCustomMenuHeaderNumberOfLevels |
| $bsgCustomMenuHeaderNumberOfMainEntries | 10 | $bsgOverrideCustomMenuHeaderNumberOfMainEntries |
| $bsgCustomMenuHeaderNumberOfSubEntries | 10 | $bsgOverrideCustomMenuHeaderNumberOfSubEntries |
{{BSExtensionInfobox
|desc=Provides customizable menus
|status=stable
|type=BlueSpice
|edition=BlueSpice free
|active=No
|compatible=BlueSpice
|license=GPL v3 only
}}
== Description ==
'''BlueSpiceCustomMenu''' is a menu with configurable items.
===Preferences===
The BlueSpiceCustomMenu is implemented as header menu. It will appear as collapsible menu above the top navigation bar. The HTML output is an unordered list.
==Usage/Features==
The extension BlueSpiceCustomMenu is '''disabledenabled by default'''.
Menu items can be modified by editing the <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 may be outside the 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 8: | Line 8: | ||
|license=GPL v3 only | |license=GPL v3 only | ||
}} | }} | ||
| − | == Description == | + | ==Description== |
'''BlueSpiceCustomMenu''' is a menu with configurable items. | '''BlueSpiceCustomMenu''' is a menu with configurable items. | ||
| Line 15: | Line 15: | ||
==Usage/Features== | ==Usage/Features== | ||
| − | The extension BlueSpiceCustomMenu is ''' | + | The extension BlueSpiceCustomMenu is '''enabled by default'''. |
Menu items can be modified by editing the <code>MediaWiki:CustomMenu/Header</code>. | Menu items can be modified by editing the <code>MediaWiki:CustomMenu/Header</code>. | ||
| Line 59: | Line 59: | ||
'''Config''' | '''Config''' | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | ! Name !! Default value !! Override by | + | !Name!!Default value!!Override by |
|- | |- | ||
| − | | $bsgCustomMenuHeaderNumberOfLevels || <nowiki>2</nowiki> || $bsgOverrideCustomMenuHeaderNumberOfLevels | + | |$bsgCustomMenuHeaderNumberOfLevels||<nowiki>2</nowiki>||$bsgOverrideCustomMenuHeaderNumberOfLevels |
|- | |- | ||
| − | | $bsgCustomMenuHeaderNumberOfMainEntries || <nowiki>10</nowiki> || $bsgOverrideCustomMenuHeaderNumberOfMainEntries | + | |$bsgCustomMenuHeaderNumberOfMainEntries||<nowiki>10</nowiki>||$bsgOverrideCustomMenuHeaderNumberOfMainEntries |
|- | |- | ||
| − | | $bsgCustomMenuHeaderNumberOfSubEntries || <nowiki>10</nowiki> || $bsgOverrideCustomMenuHeaderNumberOfSubEntries | + | |$bsgCustomMenuHeaderNumberOfSubEntries||<nowiki>10</nowiki>||$bsgOverrideCustomMenuHeaderNumberOfSubEntries |
|} | |} | ||