Skip to end of metadata
Go to start of metadata

The Navmap macro displays the list of pages associated with a specified label as a navigation map.

A label must be specified for this macro.

On this page:

To insert the navmap macro into a page using the Macro Browser,

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Once you've found the navmap macro, click 'insert' to add it to your page.

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

Parameter

Required?

Default

Description

Label

yes

none

Specify the label associated with the pages you want to show in the navigation map.

Map Title
(title)

no

none

Specify a title for the navigation map.

Number of Cells Per Row
(wrapAfter)

no

5

Specify the number of cells in a row

Cell Width (Pixels)
(cellWidth)

no

90 px

Specify the cell width

Cell Height (Pixels)
(cellHeight)

no

60 px

Specify the cell height

Navigation Map Theme
(theme)

no

Confluence

Define a theme for the navmap.

If you want to create your own navmap 'look and feel' (for example, one with rounded corners), you need to add a customised navmap macro theme file to the WEB-INF/classes/templates/macros directory. The file name convention to use is navmap-mytheme.vm. Use the name of your choice for the mytheme part of the file name, which is also the value you use for this parameter. Hence, if your theme was called navmap-roundededges.vm, use the value of roundededges for this parameter.

1. Specify a title for the navigation map

What you need to type

What you will get

{navmap:html|title=Regarding HTML}

2. Specify the number of cells in a row

The default is 5 cells.

{navmap:mylabel|wrapAfter=3}

3. Specify the cell width

The default width is 90px

{navmap:mylabel|cellWidth=120}

4. Specify the cell height

The default is 60px

{navmap:mylabel|cellHeight=120}

Related Labels Macro
Content by Label Macro
Recently Used Labels Macro
Working with Labels
Working with Macros

Take me back to the Wikis Help Guide.

  • No labels