Caption Reference Macro (Cloud)
- Harshitha Udayashankar (Inactive) (Deactivated)
The Caption Reference Macro creates a link to the captioned item you created using the Caption Item macro.
To work with Caption Reference, you must install Numbered Caption application. For more information, see Installation.
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:
Parameters
The following table provides you with a description of the parameters:
Parameter Name | Default | Mandatory | Description |
|---|---|---|---|
Anchor name | None | Yes | Enter the name of the anchor that you used when you captioned content using the Caption Item macro. The list of Anchor names accessible on the page you selected is displayed, and you can select from the list. |
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. |
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. |
Example 1
This will display the reference in the following format:
Format:
Caption (number)
example 2
This will display the reference in the following format:
Format:
Caption (number): Caption text
example 3
Example 4
example 5
example 6
To create a Caption Reference macro, Perform the following steps:
1. Create a new page or go to Edit the page where you want to create an equation.
2. 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.
3. Select Caption Reference and click Insert. The Insert 'Caption Reference' Macro window is displayed.
4. Enter the following details:
A Anchor name
B (Optional)Show caption text
C(Optional)Confluence page
D(Optional) Override link text
To edit a Caption Reference perform the following:
1. Select the block and click the edit button. The Edit 'Caption Reference' Macro window is displayed.
2. You can change any of the parameters that you want to change and then click the Save button.
To delete a Caption Reference, select the block and click the remove button. The block is deleted.