Navigation Plugin

Name	Navigation Plugin
Vendor	Pentagon Technologies (Website)
Authors	David Peterson, Ruben Miranda
Homepage	http://confluence.atlassian.com/display/CONFEXT/Navigation+Plugin
Issue Management	http://jira.adaptavist.com/browse/NAVI
Categories	Content Macros
Version	1.11
Availability	Confluence v2.0 to v2.10-m1
State	Stable
Support
License	Freeware / Open Source (BSD)
Price	Free
Release Docs	http://confluence.atlassian.com/display/CONFEXT/Navigation+Plugin
Java API Docs	n/a
Download Source	n/a
Download JAR	navigation-plugin-1.11.jar

This plugin now accessable through the Confluence Repository Client.

Description

This set of macros displays links to pages within a specific hierarchy; currently {scrollbar} and (formerly) {noparent}.

Download & Installation

Confluence 1.4, 2.0 and 2.1

1. Download: navigation-plugin-1.11.jar
2. Upload into Confluence using the Plugin Administration console.

Confluence 1.3

1. Download: macros-navigation.jar
2. Drop into WEB-INF/lib inside your Confluence web application
3. Restart Confluence

{scrollbar}

Usage

Syntax is as follows:

{scrollbar}

Parameters

• up - (optional - default is true) If 'false', no link to the parent will be shown
• icons - (optional - default is true) If 'false', no icons are shown
• no-css - (optional - default is false) If 'true', no CSS style code is output, allowing overriding of the scrollbar table's style. The CSS classes to override are listed below:

  Class	Description
  ScrollbarTable	The style for the whole table
  ScrollbarPrevIcon	The cell the left arrow is in, if present
  ScrollbarPrevName	The cell the previous page name is in, if present
  ScrollbarParent	The cell the parent page is in, if present
  ScrollbarNextName	The cell the next page name is in, if present
  ScrollbarNextIcon	The cell the right arrow is in, if present

Screenshot

Here's what the macro looks like when in use:

In this example, the hierarchy of the pages is as follows:

Table of Contents
 |
 |--> 01. Introduction
 |
 |--> 02. Housing
 |
 |--> 03. Vehicles

The order is determined alphanumerically.

Note also the following special cases:

• For documents first in the hierarchy level, a previous link is not shown.
• For documents last in the hierarchy level, a next link is not shown.
• For only-child documents, only the 'up' link is displayed (if applicable).
• For orphans, no 'up' link is displayed, but siblings are.
• When in non-standard viewing modes (eg. printing) the scrollbar is hidden.

TODO

• Push table generation to a Velocity template, for easier editing by decorators
• Add a height parameter to retrieve previous, next links for the parent, grandparent, etc. (default currently would be 0)

See Also

• Additional Documentation and Examples

{noparent}

Note This macro has been removed in version 1.11 and beyond. Simply use {children:page=/} to achieve the same functionality as this macro.

Usage

Syntax is as follows:

{noparent}

This macro generates a bulleted list of pages that do not have a parent. The space's home page is excluded from the list.

The macro itself is similar to Confluence's own {children} macro - unfortunately {children} doesn't have a way to specify a null parent. I find this macro essential when Confluence newcomers add pages, but forget to specify a parent. "Where did my page go?" (Happens quite a bit.)

See Also

• Additional Documentation and Examples

Open Issues

Release History