Documentation for Confluence 2.5.4 - 2.5.8.
Documentation for [Confluence Cloud] and the latest Confluence Server is available too.

The complete list of objects available for use are:

Name

Description

Doc Reference

$body

The body of the macro (if the macro has a body)

 

$param0-n

The parameters passed to your macro (as available)

 

$config

The BootstrapManager object, useful for retrieving Confluence properties

BootstrapManager

$content

The current ContentEntity object that this macro is a included in (if available)

ContentEntityObject

$space

The Space object that this content object is located in (if relevant)

Space

$generalUtil

A GeneralUtil object, with useful utility methods for URL encoding etc

GeneralUtil

$action

A blank ConfluenceActionSupport object, useful for retrieving i18n text if needed

ConfluenceActionSupport

$webwork

A VelocityWebWorkUtil object, for it's htmlEncode() method

VelocityWebWorkUtil

$req

The current HttpServletRequest object (if the page is rendered as a result of an HTTP request)

 

$res

The corresponding HttpServletResponse object (not recommended to be played with)

 

$userAccessor

For retrieving users, groups and checking membership

UserAccessor