Versions Compared

Old Version 11

changes.mady.by.user Harshitha Udayashankar (Inactive)

Saved on

compared with

New Version Current

changes.mady.by.user Harshitha Udayashankar (Inactive)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use the The Caption Reference Macro to link a Caption Item Macro that you have created to the section where you are working creates a link to the captioned item you created using the Caption Item macro.

Info

To work with Caption Reference, you must install Numbered Caption application. For more information, see Installation.

Panel
panelIconId2757
panelIcon:exclamation:
panelIconText❗
bgColor#FFEBE6

You must specify the Anchor name in the Caption Item macro to generate a link using the Caption Reference macro.

This page provides you with information about the following articles:

Table of Contents
minLevel1
maxLevel7

Panel
panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText:number_caption:
bgColor#EAE6FF#FFFFFF

Parameters

The following table provides you with a description of the parameters:

Parameter Name

Default

Mandatory

Description

Confluence page

Current page

❌ No

Enter the name of the page containing the Caption Item macro. Leave the parameter blank if you want to refer to the caption item from the same page.

Anchor name

❌None

✅ Yes

Enter the name of the anchor that you used when you captioned content using Caption Item macro.

The list of Anchor names accessible on the page you selected is displayed, and you can select from the list.

Show caption text

Unchecked

❌ No

Check this box to display the caption text that you entered while captioning content.

Override link text

❌None❌

No

Enter the text to be displayed as a reference to link the content.

Note

This option overrides all default formats, displaying only the text you specified as a reference link to the content.

The Show caption text is disabled automatically if you enter the Override link text.

Info

To change parameter configuration, refer to Configuration.

panelIconId
Panel
ca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText:number_caption:
bgColor#EAE6FF#FFFFFF

Working With Parameters

Status
colourYellow
titleExample 1
 

...

Expand
titleConfluence page: specified; Anchor name: specified; Show caption text: checked; Override link text: specified.

This will display the reference in the following format:

Format:

Override link text

:number_caption:
Panel
panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText
bgColor#EAE6FF#FFFFFF

Creating ‘Caption Reference' Macro

To create a LaTeX Math Block Caption Reference macro, Perform the following steps:

...

Status
colourPurple
title2.
Click the + icon. Search for the Caption Reference macro.

...

 (or) you can type { caption, the list with caption macro suggestions is displayed, and you can select the Captioned Item macro.

...

Status
colourPurple
title3.
Select Caption Reference and click Insert. The Insert 'Caption Reference' Macro window is displayed.

...

Info

For more information, refer to Parameters.

 

:number_caption:
Panel
panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText
bgColor#EAE6FF#FFFFFF

Editing ‘Caption Reference’ Macro

To edit a Caption Reference perform the following:

...

Status
colourPurple
title2.
You can change any of the parameters that you want to change and then click the Save button.

 

Panel
panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText:number_caption:
bgColor#EAE6FF#FFFFFF

Deleting ‘Caption Reference’ Macro

To delete a Caption Reference, select the block and click the Remove button. The block is deleted.

...