---
title: "Caption Reference Macro (Server)"
canonical: "https://support.appfire.com/space/NC/77463850/Caption%20Reference%20Macro%20(Server)"
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/77463884).

> ℹ️ 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 | 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.<br>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.<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://2468e713-d9a2-4924-bd45-d35e9e5fa525)
</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://a391f5b8-ee82-4dfd-87b8-5b8e07b84d76)
</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://bc5dbf61-628e-4182-93c9-71a68a03bf83)
</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://a8abe369-efcf-4ac6-80eb-99b728897d5f)
</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://1e5f89c0-f2d3-4e80-99f1-9814f50a91df)
</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://e39359b2-7995-4642-bd8f-99cfde68644a)
</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.

![image](media://44c9eb42-26b3-4045-9de0-1603bdb8c663)


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

![image](media://959a904c-8e69-49ca-b501-762cf546fd55)

[3.] Select *Caption Reference* and click **Insert**. The *Insert* '*Caption Reference' Macro *window is displayed.

![image](media://b3ad13b7-d848-43f3-9d6f-b7fa18f7e820)

[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](https://appfire.atlassian.net/wiki/spaces/NC/pages/77463850/Caption+Reference+Macro+Server#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.

![image](media://6474624c-91e8-4156-acab-71d5a4650cdc)


 

[1.] Select the block and click **Edit**. The *Edit* '*Caption Reference' Macro *window is displayed.

![image](media://7a907c32-d5a0-4f15-a5d7-48dd7815aa71)


[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.

![image](media://6474624c-91e8-4156-acab-71d5a4650cdc)


 

> ℹ️ You must be in the **Edit** mode to delete a macro block.