Access Keys:
Skip to content (Access Key - 0)

composition-setup macro

Overview:

The {composition-setup} macro is used in conjunction with the other composition macros and sets up data that they will need to function correctly...

The {composition-setup} macro may be included on its own, may contain the list of parameters, or may refer to an attachment on a page that contains the list of parameters.

Parameters:

The {composition-setup} macro itself has only one parameter which allows it to take a set of properties from a file attached to another page.

{composition-setup:defaults=Page^composition.properties}
 cloak.toggle.type = default
{composition-setup}
Parameter Required Default Notes
defaults   Refers to an attachment on a page that contains the list of overides to the default internal settings

Properties

The {composition-setup} however is used to define parameters that are used by the other composition macros, these properties are listed below

Property Default Notes
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').
cloak.memory.duration 7 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.
  • wiki - Wiki text for the two modes.
  • none - No icon at all. You will probably want to ensure that cloak.toggle.zone is enabled.
cloak.toggle.open   The value to use for the icon when the cloak can be opened.
cloak.toggle.close   The value to use for the icon when the cloak can be closed.
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 7 The number of days the deck status should be remembered for.
deck.tab.location top The location of the tab bar. ('top', 'bottom' or 'none')
deck.tab.active.border   The border for the active tab (CSS - eg. '1px dashed black')
deck.tab.active.background   The background for the active tab (CSS - eg. '#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 (eg '5px')
deck.card.border   The border for the active card.
deck.card.background   The background for the active card.

Examples


See Also



Ask questions, get help and report bugs & issues on our Community Site

View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence