Confluence 3.1 has reached end of life
Check out the [latest version] of the documentation
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:
Usage with the Macro Browser
To insert the navmap macro into a page using the Macro Browser,
- Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
- Click the Macro Browser icon
on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode. - Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
- Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to put the macro into the page.
Once you've found the navmap macro, click 'insert' to add it to your page.
Usage with the Wiki Markup Editor
Parameters
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 |
no |
none |
Specify a title for the navigation map. |
Number of Cells Per Row |
no |
5 |
Specify the number of cells in a row |
Cell Width (Pixels) |
no |
90 px |
Specify the cell width |
Cell Height (Pixels) |
no |
60 px |
Specify the cell height |
Navigation Map Theme |
no |
Confluence |
Define a theme for the navmap.
|
Examples
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 TOPICS
Related Labels Macro
Content by Label Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros
Take me back to the Confluence User's Guide.
Overview
Content Tools
Apps
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.