Documentation's navigation


On this page


What types of menu items exist?

There are four types of menu items:


Category item

Category items group submenu items.

Category items are not links themselves. They work like folders or headlines for your group of submenu items.

You can add subcategory items to create groups within groups.


Main menu item

Normal menu entries. Will be displayed as links to the target Confluence page or external URL.

Main menu items can not be placed inside categories. They are always visible at the top level of the menu.


Submenu item

A submenu item is similar to a main menu item, but can be nested. It's always a child of a parent element - like a category item or a main menu item.



Separator

Separators are vertical lines which can separate menu items.




Add a menu item

Main menu item

To add an item to the main menu, click on the + Main menu item button.

The new item will be added to the bottom of the list.



Configuration

Enter a title (for example About us) and the link to the page this item should lead to. You can also choose an icon for this link.

Enter the attributes which are defined in menu personalization. Those information are connected to user profiles. If you enter "USA" as a country, the menu item will only be shown to employees with "USA" chosen as a country insider their user profile. 

Activate the Open in new tab checkbox if you want that the link opens in a new tab.

To add another main menu item, repeat this step.





Submenu item

To add a submenu item, find the parent item.

Click on the Add  button inside the Actions tab

From the now open context menu, click on Append submenu item.



Configuration

Enter a title and the link to the page this item should lead to. You can also choose an icon for this link.

Enter the attributes which are defined in menu personalization. Those information are connected to user profiles. If you enter "USA" as a country, the menu item will only be shown to employees with "USA" chosen as a country insider their user profile. 

Activate the Open in new tab checkbox if you want that the link opens in a new tab.





Category item

To add a main category item, click on the + Category item button.

The new item will be added to the bottom of the list.



Configuration

Enter a title of your category. You can also add an icon.

Enter the attributes which are defined in menu personalization. Those information are connected to user profiles. If you enter "USA" as a country, the menu item will only be shown to employees with "USA" chosen as a country insider their user profile. 





Subcategory item

To add a subcategory item, click on the Add  button inside the Actions tab.

From the now open context menu, click on Append subcategory item.



Configuration

Enter a title of your category. You can also add an icon.

Enter the attributes which are defined in menu personalization. Those information are connected to user profiles. If you enter "USA" as a country, the menu item will only be shown to employees with "USA" chosen as a country insider their user profile. 





Separator

To add a separator, click on the + Separator button.

A separator will be added to the bottom of the list.



Alternatively, click on the Add  button inside the Actions tab.

From the now open context menu, click on Append separator.



Change the order of your menu items

To change the order of menu items, use the arrow buttons in the Position tab.



The ID

The ID assigned to each menu item specifies the place of the item inside the menu. The menu uses an ascending order.

This means, that ID 1 will be the first menu item, ID 2 the second one and so on.

The higher the ID, the later (more to the right) the menu item appears inside the menu.




Convert menu items

You can:

  • Convert main menu items into submenu items.
  • Convert submenu items into main menu items.
  • Convert category items into subcategory items.
  • Convert subcategory items into category items.



To convert items into others, use the Arrow buttons inside the Position tab

The Right arrow  button will convert a main element into a child element.

The Left arrow ← button will convert a child element into a parent element.


Alternatively, you can use drag and drop to convert menu items.




The Menu Editor has an autocomplete function for Confluence links. If you want to add a Confluence page to your navigation, type the page's title into the "Link" input field.


Info

If you want to use relative links without the base URL, which will always remain the same (even when copied from the productive instance to a testing instance), do not use Confluence shortlinks (which have the following structure: /x/GQCXD).

Confluence shortlinks will always be updated by the app to include the full base URL, which means that as soon as you copy the configuration and import it to another instance, the links won't work anymore.

Please use regular relative links (URI) instead.


The editor will show you all related Confluence pages. Click on the page you want to link to.

If you paste a Confluence link by hand, the editor will transform it into a Confluence shortlink anyway.


Info

Permissions still apply! If a user has no permission to view a page, the link won't be shown in their menu.



Info

The editor differentiates between page and space links.


Page links lead to one certain page. The page you linked. If this page gets removed, the link stops working.

Space links always lead to the space homepage. Even if the space homepage is changed. The link will lead to the new homepage anyway.


External links are marked with an icon . This icon indicates that the link leads away from Confluence.

External links are not verified by the editor whatsoever. Make sure that the link address is correct or the link won't work.



Active menu item indicator

A Confluence or Linchpin intranet can be quite massive with tens of thousands of pages. Naturally, not all of them will be part of your navigation menu. But probably still a lot of them.

An optical hint shows the top level menu item the current page belongs to.

This indicator is implemented via CSS classes. Use CSS to customize this indicator, if you wish to.



CSS classes

active-item

If the current page itself is part of the menu, this menu item will have the class active item.

active-item-trail

If the current page is part of a space that's part of the menu, this menu item and all of its parents will have the class active-item-trail.

Restrictions

There are some restrictions to this functionality you should know about:

  • If the space the current page belongs to is not part of the menu at all, there will be no indicator.
  • If the space the current page belongs to is part of the menu several times, only the first occurrence will be indicated.
  • If the menu item points to the space homepage instead of the space itself, there will be no indicator. Please make sure to link to spaces in the menu, not to space homepages.



This page was last edited on 09/29/2023.