Menus
How to configure menus for the header and the footer.
The Enterprise Theme lets you embed a menu easily into the header and the footer. It's even possible to have different menus for different spaces. Furthermore, menus can be different depending on the user's language.
Enable Enterprise Theme
The Enterprise Theme has to be enabled. Otherwise, the theme settings you make won't have any effect.Adding, editing and deleting menus
Choose the cog icon, then choose General configuration.
Select Menus under Enterprise Theme in the left-hand panel. This will list the two default menus for the header and the footer and other menus that have been configured.
You can now:
Add a new menu by clicking the Add Menu button
Configure an existing menu
Edit the name of a menu
Delete a menu (the two global menus can not be deleted)
Configure a menu
Click the Configure link under Operations. This will open the menu structure of that menu.
Here you can:
Configure a menu structure for each language that is installed in Confluence. Users will see only the menu for the language they have set in their profile. However, users who have set a language for which no menu is defined will see the default menu instead. The default language, marked with DEFAULT, is defined by the language set as the default language in Confluence. It is advisable to at least configure the menus for the default language as it is the "fall-back" menu.
Adding menu items:
Click the plus icon ➕ on a language section to add a menu item to that specific language menu.
Click the plus icon ➕ on a menu item to add a sub-menu item. Menus can be up to tree levels deep.
Click the pencil icon 🖊️ to edit an existing menu item.
Click the trash icon :trash-bin: to delete an existing menu item. Be aware that this will delete all child items as well.
Reorder the menu by simply dragging the item by the menu icon on the left side. You can even drag menu items from one language section to another one.
Adding or editing a menu item
Clicking on the plus icon ➕ to add a new menu item or clicking the pencil icon 🖊️ to edit an existing one will bring up the following dialogue:
Type
There are four different types of menu items. The field for the item's destination will change depending on which item type you selected.
Type | Filed | Menu item is used for |
---|---|---|
Group | - | grouping several items together. If this type is used on the top level of a menu, it acts as a drop-down menu. On the second menu level, groups are arranged horizontally and their children will be arranged underneath. In the example below, you see a header menu with the group Projects opened. The two child groups Star Fleet alpha and Star Alliance beta are arranged next to each other with their child items below them. |
Space | Space picker | linking to a space home page |
Page | Page search field | linking to a page |
Link | Address text field | any other internet address such as http://www.bitvoodoo.ch, mailto://support@bitvoodoo.ch, etc. |
Name
This is the item's name that will be displayed in the menu.
Mouseover
This is a description that will be displayed when the mouse is hovered over the menu item.
Restrictions
If a menu item should only be visible to certain Confluence groups, those groups can be specified here. Leave this field blank if all Confluence users are allowed to see the menu item.
Open the link in a new tab
Use this checkbox if you want that a menu item is opened in a new browser tab.
Please note that only menu structures up to 3 levels are supported.
Embedding menus in the header and footer
The next step is to ensure the header and footer menus are displayed in the Enterprise Theme layout. To do this, you must configure the Enterprise Theme sections for the header and the footer. By default, the header and footer sections already contain the macro Metamenu with the correct parameters set to display the Global Header and Global Footer in the header and footer sections.
Configure the header and footer sections:
Choose the cog icon ⚙ at the top right of the screen, then choose General configuration.
Select Sections under Enterprise Theme in the left-hand panel.
Click on the section for the header or the footer. This will open the editor for that section.
Make sure the Metamenu macro is present in the section by:
Configure the parameter of the Metamenu macro:
Menu: Select the menu to be used.
Hide from anonymous users: If this checkbox is checked, anonymous users do not see the menu.
Style:
flat and menu3: With these two menu styles, second-level menu items are rendered in drop-downs and third-level items are grouped together (see menu item types above as well). These two menus are preferred for header menus.
bv-footer: This style renders every first-level menu item into a column, with the second-level items listed vertically below them. Items of the third level are not being rendered with this style. It is the preferred style for footer menus.
Having a different header and footer in a space
It is possible to have different header and footer menus in different spaces instead of the one defined globally. For this to make sense, at least one additional menu should be configured besides the Global Header and Global Footer. Please refer to the paragraph Adding, editing and deleting menus above.
To define menus in a space:
Go to the space in which you would like to embed the menus.
Navigate to the space administration. Please refer to the page Navigating to the Space Administration if you are unsure how to find it.
Select Sections under Enterprise Theme.
Configure the Metamenu macro in the header and footer sections in the same way as you would do for the global sections. Please refer to the paragraph "Embedding menus in the header" and footer above.
For more information about editing sections, go to the Sections documentation.
Why is my menu or my footer not being displayed?
This could have a couple of reasons:
There is no menu defined for the language of your user profile and the default Confluence language.
It is recommended to at least define a menu for the default language of Confluence. Users who have a language in their profile for which no menu is defined see the menu in the default language.The menu is not embedded in the sections of the Enterprise Theme. Please refer to Embedding menus in the header and footer paragraphs above.
Why are certain menu entries not being displayed?
Whether a menu entry is displayed or not depends on permissions and user profile settings. If certain menu entries are missing, please check (or let a Confluence administrator check):
Does the menu structure differ in different languages? For instance, changing the language in your user profile will give you a different language structure.
Are there special restrictions on the menu item itself (can be configured on each menu item in the menu configuration, see restrictions on menu items above).
In case a space is linked in the menu: Do you have permissions for this space and the start page of this space (see page restrictions)?
In case a page is linked in the menu: Are there Page restrictions that prevent you from seeing this page?
How can I remove the Header (or Footer) menu if I don't need it?
By default, the header and footer sections already contain the macro Metamenu to display a menu in the header and footer sections. This macro can simply be removed:
Configure the header and footer sections:
Choose the cog icon ⚙ at the top right of the screen, then choose General configuration.
Select Sections under Enterprise Theme in the left-hand panel.
Click on the section for the header or the footer. This will open the editor for that section.
Delete the Metamenu macro in the section. Save your changes.