---
title: "Caption Reference Macro (Cloud)"
canonical: "https://support.appfire.com/space/NC/77463841/Caption%20Reference%20Macro%20(Cloud)"
format: markdown
---
> Macro (aura-html)

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](https://appfire.atlassian.net/wiki/spaces/NC/pages/77463802/Installation+Cloud).

> ℹ️ 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.<br>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.<br>> ⚠️ 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](https://appfire.atlassian.net/wiki/spaces/NC/pages/77463887).


> ℹ️ ### Working With Parameters

[Example 1]  

<details>
<summary>Confluence page: default; Anchor name: specified; Show caption text: default; Override link text: default.</summary>

This will display the reference in the following format:

> Format:
> 
>          Caption (number)

![image](media://57000e0f-4457-45d9-a908-f277a5072e69)
</details>

[example 2] 

<details>
<summary>Confluence page: default; Anchor name: specified; Show caption text: checked; Override link text: default.</summary>

This will display the reference in the following format:

> Format:
> 
>          Caption (number): Caption text

![image](media://c4f7d99a-2dfc-4054-a8ef-92a9a90c9e10)
</details>

[example 3] 

<details>
<summary>Confluence page: default; Anchor name: specified; Show caption text: checked; Override link text: specified.</summary>

This will display the reference in the following format:

> Format:
> 
>         Override link text

![image](media://13798038-da78-43d3-a072-fe0f66cebbfe)
</details>

[Example 4] 

<details>
<summary>Confluence page: specified; Anchor name: specified; Show caption text: unchecked; Override link text: default.</summary>

This will display the reference in the following format:

> Format:
> 
>          Caption (number) ((page name))

![image](media://40aea642-40b1-4bcb-887e-1e29e3a2e525)
</details>

[example 5] 

<details>
<summary>Confluence page: specified; Anchor name: specified; Show caption text: checked; Override link text: default.</summary>

This will display the reference in the following format:

> Format:
> 
>          Caption (number) Caption text ((page name))

![image](media://0b1b19f1-d552-4a0b-ae8d-c7bfe0c5869c)
</details>

[example 6] 

<details>
<summary>Confluence page: specified; Anchor name: specified; Show caption text: checked; Override link text: specified.</summary>

This will display the reference in the following format:

> Format:
> 
>          Override link text

![image](media://21741ba4-dc81-48f5-a0e4-9a1e65cfc304)
</details>


> ℹ️ ### 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 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*

> ℹ️ For more information, refer to [Parameters](https://appfire.atlassian.net/wiki/spaces/NC/pages/77463841/Caption+Reference+Macro+Cloud#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 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.

 

> ℹ️ ### 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.