Confluence Docs 3.0 : Navmap Macro This page last changed on Jun 11, 2009 by ggaskell. 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 Usage with the Wiki Markup Editor Parameters Examples ## Usage with the Macro Browser To insert the navmap macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then 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
What you need to type | What you will get
--- | ---
{navmap:html} |
1. QuickStart Guide | 1. QuickStart Guide | 1. QuickStart Guide | 1. QuickStart Guide | 1. QuickStart Guide
1. QuickStart Guide | 3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds
3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds | Advanced HTML encoding | Advanced HTML encoding | Advanced HTML encoding
Advanced HTML encoding | Anti-XSS documentati- on | Anti-XSS documentati- on | Anti-XSS documentati- on | Anti-XSS documentati- on
clover-html-- report | clover-html-- report | clover-html-- report | clover-html-- report | clover-html-- report
clover-html-- report | clover-repor- t | clover-repor- t | clover-repor- t | clover-repor- t
clover-repor- t | clover-repor- t | Custom HTML may cause pages using the Pagetree macro to spin when viewed using Internet Explorer (IE) | Customized HTML Breaks the "Edit Custom HTML" Page | DOM002 Illegal character Exception Occured For A User
Edit in Word Link Macro | Edit in Word Link Macro | Home | HTMLDiff | HTML Include Macro
HTML Include Macro | HTML Include Macro | HTML Include Replace | HTML Macro | HTML Macro
HTML Macro | HTML Macro | HTML Macro | HTML Macro | HTML Tag
NewsFeedMake- r | Using Exported HTML in Word | View File Macro | View File Macro
## Parameters Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
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.
## Examples 1. Specify a title for the navigation map
What you need to type | What you will get
--- | ---
{navmap:html|title=Regarding HTML} |
Regarding HTML
1. QuickStart Guide | 1. QuickStart Guide | 1. QuickStart Guide | 1. QuickStart Guide | 1. QuickStart Guide
1. QuickStart Guide | 3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds
3. Using Clover in Automated Builds | 3. Using Clover in Automated Builds | Advanced HTML encoding | Advanced HTML encoding | Advanced HTML encoding
Advanced HTML encoding | Anti-XSS documentati- on | Anti-XSS documentati- on | Anti-XSS documentati- on | Anti-XSS documentati- on
clover-html-- report | clover-html-- report | clover-html-- report | clover-html-- report | clover-html-- report
clover-html-- report | clover-repor- t | clover-repor- t | clover-repor- t | clover-repor- t
clover-repor- t | clover-repor- t | Custom HTML may cause pages using the Pagetree macro to spin when viewed using Internet Explorer (IE) | Customized HTML Breaks the "Edit Custom HTML" Page | DOM002 Illegal character Exception Occured For A User
Edit in Word Link Macro | Edit in Word Link Macro | Home | HTMLDiff | HTML Include Macro
HTML Include Macro | HTML Include Macro | HTML Include Replace | HTML Macro | HTML Macro
HTML Macro | HTML Macro | HTML Macro | HTML Macro | HTML Tag
NewsFeedMake- r | Using Exported HTML in Word | View File Macro | View File Macro
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 Guide.

Document generated by Confluence on Nov 05, 2009 23:35