The {cloak} macro is used in conjunction with the toggle-cloak macro to show and hide blocks of content...
When pages become extremely large, or when there is information that might not always be required, you can use this macro to temporarily hide blocks of content. The user can show or hide cloaked blocks using on-screen navigation provided by the toggle-cloak macro.
The {cloak} macro has the following parameters:
{cloak:id=i|visible=v}
your content
{cloak}
Parameters
Parameter
Required
Default
Notes
id
The unique ID to assign to a cloaked block of content. The toggle-cloak macro uses this ID to show and hide that block of content.
visible
false
By default the cloaked content will be hidden, but you can set this parameter to true to show it by default.
This plug-in is available without cost for both commercial and non-commercial purposes. However, if you have found it to be useful, particularly within a commercial environment, please consider making a donation to the author. This will encourage continued development of this and other plug-ins, as well as speeding up the response for your latest maintenance request.
If you wish to donate, it can be done easily with a credit card or bank transfer using Paymate. No account sign-up is required for credit card payments.
This macro is compatible with Confluence 1.3.x, 1.4.x and 2.x. It has been tested by Adaptavist with Confluence 1.4.1, 1.4.3 and 1.4.4. It has been tested by David Peterson with Confluence 2.0.
This macro is usually pre-installed with Builder accounts. If you wish to install it on your own Confluence install, please download it from the RandomBits Website.
Adaptavist maintain a JIRA Project for tracking bug reports and feature requests for this macro. The currently reported items are shown below:
jiraissues: Could not download[ http://jira.adaptavist.com/secure/IssueNavigator.jspa?view=rss&pid=10036&component=10101&statusIds=1&statusIds=3&statusIds=4&statusIds=5&sorter/field=updated&sorter/order=DESC&tempMax=25&reset=true&decorator=none] : caused by : Circular redirect to 'http://jira.adaptavist.com:80/secure/IssueNavigator.jspa'
{cloak:id=MyCloakID}This content will be cloaked{cloak}
Results in: This content will be cloaked
Cloaked content by default is invisible (ie cloaked), to reveal it you will need to use the {toggle-cloak} macro
Uncloaking by default
{cloak:id=MyOtherCloakID|visible=true}This content can be cloaked{cloak}
Results in: This content can be cloaked
Hints and Tips
Remember to include the composition-setup macro at the top of your content when using the cloak macro. You should also ensure that you have at least one toggle-cloak macro for each cloaked section of your content so that the user can display that content.