Here you can find current Information:
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 (when using menu categories).
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 Navigation Menu Editor Manual, 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 until the user chooses to end the work on the menu structure. 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.
- 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.
Display navigation entries based on user values
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.
For ease of use, the input fields offer autocompletion for any values you have already entered in the menu structure.
Since version 1.6 you can use the following wildcards and logical operators to create even more complex filters based on Confluence user values:
Wildcards and complex filters
| 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' |
| ( ... ) | Change evaluation order | NOT (de* OR en*) Normally, the evaluation order is NOT -> AND - > OR, so NOT de* OR en* would match values that start with 'en'. |
Filter constraints
Due to the wildcards and logical operators it is not possible to directly filter by attributes containing these key words. Replace at least one character of the key word with the wildcard '?' to match best.
These keys are case sensitive, so "And" or "and" would not match.
| Filter Attribute | Workaround | Key word |
|---|---|---|
| New York (State) | New York ?State? | ( ) |
| HR AND QS | HR AN? QS | AND |
| NOT for everybody | NO? for everybody | NOT |
| This OR That | This O? That | OR |
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.
Links to Confluence pages and external URLs
The input field for adding links has an auto completion for confluence spaces and pages. Permissions 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 base URL matches 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 instance.
Backup of menus (v1.6)
In version 1.6, we have introduced a backup feature. 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. When you create more backups, the oldest ones will be overwritten.
Others
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.
Developer documentation
Known issues
Parentheses in filters are treated wrong
Since we have introduced complex filters for navigation entries, parentheses in filters are treated as logical characters. So your filter might be broken if you try to filter by attributes containing parentheses.
A workaround would be using the wildcard '?' instead of a parenthesis. See: Filter constraints.
Special characters in page titles
Some customers have reported broken links in the navigation, if the title of your linked page contains special characters. If so, please use the Confluence short links for these pages.