/
Composition Setup

Composition Setup

Owned by Technical Communications
Last updated: Jul 21, 2025

This macro performs setup operations for some of the Composition macros. It also sets page-wide defaults and customization of various elements of tabs or cloaked content.

This is an optional macro when using the Deck of Cards macro to create cards or when creating cloaked content.

Place this macro at the top of the page. Otherwise, it can’t function.

Not all macros are currently available on cloud.

Macros will be migrated along with the page, and no data will be lost after migration. On cloud, macros are hidden in view mode, but visible in edit mode, where they are marked as Legacy. For more details, refer to FAQ on the migration from Composition Data Center.

Parameters

Name

Required

Migratable to cloud?

Default value

Description

defaults

 Optional

No

 

The name of the attached file containing the default settings for this page. For example, Home^composition.properties.

The file must be a text file with properties listed as described below.

Notes

Currently, there is no method of inputting the defaults parameter when editing the markup. If you want to add this parameter, you must use the Wiki Markup method.

The following table lists the properties supported by the Composition Setup macro. You can set the properties in the body of the Composition Setup macro. Alternately, you can set the properties in a text file attached to the page and linked via the defaults macro property.

Name

Default

Description

Name

Default

Description

import.css

 

Allows a Cascading Style Sheet to be imported into the page. The value may be an attachment link (e.g. 'Foo^bar.css'), an absolute link (e.g. 'http://foo.com/bar.css') or a server-relative link (e.g. '/bar.css').

When uploading a CSS file, ensure the attachment properties for the file, specifically the property New Content Type, is 'text/css' and NOT 'applications/x-upload-data' or you may experience issues.

cloak.memory.duration

0

The number of days the cloak status should be remembered for.

cloak.toggle.type

default

The type of toggle to display. Options are:

  • default - Blue arrows pointing up or down.

  • custom - A custom image for each of the modes.

  • text - Plain text for the two modes.

  • none - No icon at all. You will probably want to ensure that cloak.toggle.zone is enabled
    Note that type = wiki has been deprecated since Confluence 4

cloak.toggle.open

 

The value to use for the icon when the cloak can be opened. The value may be an attachment link (e.g. 'Foo^bar.css'), an absolute link (e.g. 'http://foo.com/bar.css') or a server-relative link (e.g. '/bar.css').

cloak.toggle.close

 

The value to use for the icon when the cloak can be closed. The value may be an attachment link (e.g. 'Foo^bar.css'), an absolute link (e.g. 'http://foo.com/bar.css') or a server-relative link (e.g. '/bar.css').

cloak.toggle.exclusive

false

If 'true', all the toggles on the page will be exclusive. That is, at each level, only one cloak is open at a time.

cloak.toggle.zone

true

If 'true', the heading or paragraph the toggle is in will be clickable.

deck.memory.duration

0

The number of days the deck status should be remembered for.

deck.tab.location

top

'top', 'bottom' or 'none'. The location of the tab bar.

deck.tab.active.border

 

The border for the active tab (CSS - e.g. deck.tab.active.border = 1px dashed black)

deck.tab.active.background

 

The background for the active tab (CSS - e.g. deck.tab.active.background = #ff0055)

deck.tab.inactive.border

 

The border for inactive tabs (CSS)

deck.tab.inactive.background

 

The background for inactive tabs (CSS)

deck.tab.spacer

 

The distance between tabs (e.g. '5px')

deck.card.border

 

The border for the active card.

deck.card.background

 

The background for the active card.

deck.width/deck.height

 

The width and/or height the content will be constrained to (not including any tabs). If not set, the tabs expand to display their content.

deck.startHidden

true

If set to 'false', the cards will be initially visible on the page until setup is complete.

deck.loopCards

false

If 'true', the deck will loop back to the beginning from the last card and vice versa.

deck.nextAfter

 

The number of seconds the slides will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.

deck.effect.type

none

The effect to use when moving to a new slide. May be 'fade' or 'none'.

deck.effect.duration

0

The number of seconds the transition will take to complete. e.g. '1.5'. Defaults to 0.

 

Related pages