[All Adaptavist Apps]

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Wiki Markup
The most basic use of these macros is to output a single menu item:

{code}
 {menuitem}[Home Page|Home|Go to the Home Page]{menuitem}
{code}

Which results in:

{menuitem}[Home Page|USERGUIDE:Home|Go to the Home Page]{menuitem}

We've used a wiki notation link in the example above to create a link to the Home page within the current space. You can use any valid wiki notation link inside a menu item so you could, for example, link to a news item, different space or even a user profile.

It should be noted that if you link to a page in a menu item, and then rename that page, the menu item will not update itself to use the new name of the page. You can get round this problem by using the [USERGUIDE:wikimenu macro] which allows you to create a normal bullet list of links on a page (which _will_ be updated if you rename pages) and then import them in to your menu.

For all common locations within Confluence, we recommend using the [USERGUIDE:menulink macro] as it will be more reliable, especially if any of the common locations are changed in a later version of Confluence. For example, to create an ultra-reliable link to a home page, use:

{code}
 {menuitem}{menulink:home|tooltip=Go to the Home Page}Home Page{menulink}{menuitem}
{code}

This might seem like overkill, but it really is far, far more reliable to link to common Confluence locations this way. Anyway...

You can have several items at the same level, for example:

{code}
 {menuitem}{menulink:home}Home Page{menulink}{menuitem}
 {menuitem}{menulink:dashboard}Dashboard{menulink}{menuitem}
{code}

Which gives:

{menuitem}{menulink:home}Home Page{menulink}{menuitem}
{menuitem}{menulink:dashboard}Dashboard{menulink}{menuitem}

As you can see, the items are merely output as an unordered list. To put them in to an actual menu bar, simply wrap them in the [menubar macro]{footnote}Remember to specify a unique ID for the menubar macro, otherwise it won't work!{footnote} as shown below:

{code}
{menubar:id=demo1}
 {menuitem}{menulink:home}Home Page{menulink}{menuitem}
 {menuitem}{menulink:dashboard}Dashboard{menulink}{menuitem}
{menubar}
{code}

{display-footnotes}

Which results in:

{menubar:id=demo1}
 {menuitem}{menulink:home}Home Page{menulink}{menuitem}
 {menuitem}{menulink:dashboard}Dashboard{menulink}{menuitem}
{menubar}

As you can see, the items are shown next to each other because they are at the same hierarchical level. To create pop-up sub menus, you need to create a hierarchical structure...

...