Navigation Map Macro

The Navigation Map macro displays a navigable map of the pages tagged with a given label.

To add the Navigation Map macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros
  2. Find and select the required macro

Speed it up with autocomplete: Type and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.

To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Label

none

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

This parameter is unnamed in storage format and wikimarkup.

Map Title
(title

none

Specify a title for the navigation map.

Number of Cells Per Row

(wrapAfter)

5

Specify the number of cells in a row

Cell Width (Pixels)
(cellWidth

90

Specify the cell width (enter a number only, don't include px)

Cell Height (Pixels)
(cellHeight

60

Specify the cell height (enter a number only, don't include px)

Navigation Map Theme
(theme )

Confluence

Define a theme for the navmap (Server only).

If you want to create your own navmap 'look and feel' (for example, one with rounded corners), you need to add a customized navmap macro theme file to the WEB-INF/classes/com/atlassian/confluence/plugins
/macros/advanced
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.

This example is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: navmap

Macro body: None.

{navmap:mylabel|wrapAfter=4|title=My map name|cellHeight=50px|theme=navmap-mytheme.vm|cellWidth=80px}

 

 

Last modified on Nov 4, 2019

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.