This is how you administer the Navigation Menu Editor
The Navigation Menu Editor configuration contains three tabs Settings, Structure and Help.
Settings
Display options
Activate the option Display navigation in header to integrate your menu automatically below the Confluence application header.
Besides the classic dropdown layout you can display the navigation in a multi-column flyout style. Then the second level of the navigation will show up on a large panel like Amazon's or eBay's navigation.
You can choose to show the menu to not logged in users if your Confluence instance is accessible by anonymous users.
Attributes for user restriction
Choose up to three user profile fields to create a menu based on a user's profile. Click on the Assign menu button to assign field values to any menu entries. If you allow anonymous users to view the menu, they will only be shown menu items without assigned field values.
Using our Custom User Profile, you can greatly extend the range of available profile fields (including fields that are maintained in a LDAP/AD).
Menu editors
Configure which users or user groups are allowed to edit the menu structure. They will be shown a configuration "gear wheel" link at the right side of the menu.
Unlock menu
If a user starts editing the navigation structure, nobody else can access this view. It gets locked the editor logs out nor his session expired (Please be aware, that if your admin session expires, you are not able to save your menu. The Confluence default admin session expire time is set to 10 minutes). Confluence administrators can always unlock the editor view, but they should keep in mind that unlocking the navigation edit view might cause the loss of changes made by an currently active editor.
Structure
Entry types
- Category item: To separate a simple menu item list with a specific wrapper you can use a category item.
- (Main) Menu item: Normal menu entries which will be displayed as list entries with a link to the target page or URL. You can leave the link field blank to create a 'dummy' item. (See Adding Confluence links and external ones)
- Separator item: To separate groups of different menu items you can use a separator line.
Moving menu entries
Move the menu items by Drag'n'Drop or use the buttons in each row to change the order or depth.
Filter menu by defined attributes
You can set up filters on the right panel to hide navigation items you are not interested at the moment. These filters only affect the edit structure view.
Please note our filter constraints
Preview your navigation structure
To see a preview of your edited navigation structure simple click on the preview button on the right panel. You can also use the filter boxes to simulate a Confluence user's profile values to see how your navigation structure would be displayed for this user.
Open link in a new Window
You can configure if a link is opened in a new window by checking the box.
Display navigation entries based on user values (Assign menu)
If you have configured filtering attributes in the settings view, you can switch to the "Assign menu" tab and define profile field values for each menu item. The item will only be shown to users when their profile matches the entered values.
To preview the menu structure for certain attributes, you can enter arbitrary values under "Filter menu by defined attributes" as described above. The menu structure will get updated as you type. For ease of use, the input fields offer auto-completion for any values you have already entered in the menu structure and current profile field values of your Confluence users.
Use the wildcards and logical operators to create even more complex filters based on Confluence user values (See Wildcards and logical operators).
Preview
You can get a preview for a given filterset to check if you configured everything right. (Note: You can only use the preview if any filter field is configured).
History
See Backup of menus
Help
Provides further Information about the usage of the Navigation Menu Editor.
Others
Adding Confluence links and external ones
The field for adding links has an auto completion for confluence spaces and pages. Permission will be respected, so if a user has no permission to view a page, the link won't be shown. If you paste a confluence link by hand, the plugin will resolve this link and build a readable entry as if you added it by auto completion. This only works, if your configured baseurl matches to the pasted url. Please be aware, that this is necessary for checking content permissions for the user!
You can also add external links, which will not be checked by the Navigation Menu Editor. So make sure they work and are available from your Confluence.
Filter constraints
Due to the "Wildcards and logical operators" it is not possible to use key words in filter attributes. Replace the key words with to same number of signs "?" to match best.
These keys are case sensitiv so "And" or "and" would not match.
| Filter Attribute | Workaround | Key word |
|---|---|---|
| New York (State) | New York ?State? | ( ) |
| HR AND QS | HR ??? QS | AND |
| NOT for everybody | ??? for everybody | NOT |
| This OR That | This ?? That | OR |
Wildcards and logical operators
Bisher konnten Sie schon Menüpunkte für bestimmte Profilwerte zuweisen. Nun können Sie nicht mehr nur exakte Werte verwenden, sondern auch Platzhalter für einzelne oder mehrere Zeichen. Mittels logischen Operatoren (AND, OR, NOT) können Sie auch komplexere Filter erstellen, um z.B. einen Menüpunkt allen Nutzern anzuzeigen, die nicht Deutsch als Confluence-Sprache nutzen ("NOT de*").
| Wildcard / Operator | Description | Example |
|---|---|---|
| blank | matches any value | |
| ? | matches a single character | C?O matches CEO and CTO , but not C3PO |
| * | matches 0 or more characters | en* matches en , en_GB , en_US, but not de_DE or men |
| OR | Logical 'or' operator | en_GB OR fr_FR matches en_GB and fr_FR , but not de_DE |
| AND | Logical 'and' operator | en* AND *GB matches all values that start with en and end with GB |
| NOT | Logical 'not' operator | en* AND NOT en_US matches all values that start with en except en_US |
Backup of menus
With this version we are introducing a backup functionality. Every time you save a menu structure, a backup will be created. You can list all created backups by clicking on the history button on the controls panel. Click on any history entry to restore a specific backup. To publish this backup just save the menu structure.
The history has a limit of 100 backups.
Insert menu
Add the menu macro at the desired position (e.g., after the page header) as shown in the following code snippet:
$helper.renderConfluenceMacro("{display-menu}")
Displayed entries
- the target is an external URL or
- the target Confluence page exists.
Installation
The Navigation Menu Editor can be installed via the Atlassian Marketplace (Administration > Find new add-ons).
Please make sure you've also got the LinchpinConnector in version 0.4.7 after the installation.