cloak - Atlassian Plugins

card

Macros

collection-filter

{cloak}

Plugin: Composition Plugin

Creates a cloaked section which can be toggled between being visible and hidden.

Description

This macro is usually used in coordination with a toggle-cloak macro.

Requires that composition-setup is placed above it in the page.

Usage

h1. {toggle-cloak:id=My Cloak} My Cloak
{cloak:id=My Cloak|visible=true}
My Cloak content.
{cloak}

Parameters

Name	Required	Default	Description
id			The unique ID of the cloaked section. May be '*' to be an auto-id.
visible		false	If 'true', the section will be visible initially.

Examples

Simple Cloak

This is an example of a simple cloak setup which will default to all cloaked sections starting out hidden.

{composition-setup}

h2. {toggle-cloak:id=one} Section One

{cloak:id=one}
This is the contents of section one.
{cloak}

h2. {toggle-cloak:id=two} Section Two

{cloak:id=two}
This is the contents of section two.
{cloak}

Exclusive Cloak

This is an example of a simple cloak setup which will only reveal one section at a time.

{composition-setup}
cloak.toggle.exclusive = true
{composition-setup}

h2. {toggle-cloak:id=one} Section One

{cloak:id=one}
This is the contents of section one.
{cloak}

h2. {toggle-cloak:id=two} Section Two

{cloak:id=two}
This is the contents of section two.
{cloak}