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 |
|---|---|---|---|
Confluence page | Current page | ❌ | 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 | ❌ | ✅ | 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 | ❌ | Check this box to display the caption text that you entered while captioning content. |
Override link text | ❌ | ❌ | Enter the text to be displayed as a reference to link the content. 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. |
To change parameter configuration, refer to Configuration.
Working With Parameters
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
This will display the reference in the following format:
Format:
Override link text
EXAMPLE 4
This will display the reference in the following format:
Format:
Caption (number) ((page name))
EXAMPLE 5
This will display the reference in the following format:
Format:
Caption (number) Caption text ((page name))
EXAMPLE 6
This will display the reference in the following format:
Format:
Override link text
Creating ‘Caption Reference' Macro
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 caption macro suggestion 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 and click Insert.
A (Optional)Confluence page
B Anchor name
C (Optional)Show caption text
D(Optional) Override link text
For more information, refer to Parameters.
Editing ‘Caption Reference’ Macro
To edit a Caption Reference perform the following:
You must be in the Edit mode to edit a macro block.
1. Select the block and click Edit. 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.
Deleting ‘Caption Reference’ Macro
To delete a Caption Reference, select the block and click the Remove button. The block is deleted.
You must be in the Edit mode to delete a macro block.