Captioned Item Macro (Server)

Owned by Harshitha Udayashankar (Inactive) (Deactivated)
Last updated: Sept 29, 2022
4 min read

This macro helps you to caption content. The caption numbers are auto-incremented according to the type of content. For example figures, and tables.

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

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

Parameter Name

Default

Mandatory

Description

Caption name

None

Yes

Enter the name of the caption for the content. The Caption name functions as a base and the content is auto-numbered based on the caption name.

For example:

If you are captioning a table, specify the Caption name as the table.

All content with the Caption name as a table is auto-numbered based on the position of the content.

Anchor name

Randomly generated

No

(With constraints)

The name allows you to link the content to another section or a page. By default the name is automatically generated. To replace the name of your choice overwrite the parameter.

  • You must specify Anchor to use the content as a reference on any other page or on the existing page.

  • This is only a reference name; it will not appear in the UI.

Caption

None

No

Enter the caption for the content. The caption serves as a description to the content and it is displayed alongside the Caption name.

Horizontal Alignment

Right

No

Choose the horizontal alignment for the content from the drop-down menu.

The following are the available alignment options:

  • Left

  • Center

  • Right

Position

Bottom

No

Choose the position of the caption from the drop-down menu.

The following are the available position options:

  • Top

  • Bottom

 

Example 1

This will display the reference in the following format:

Caption name (number):

Example 2

This will display the reference in the following format:

Caption name (number): Caption

 

example 3

This will display the reference in the following format:

Caption name (number): Caption

 

To create a Captioned Item, Perform the following steps:

  1. Create a new page or go to Edit the page where you want to create caption.

  2. Select the content you want add a caption.

  3. Click the + icon and search for the Captioned Item macro

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

4. Select Captioned Item and click Insert. The Insert 'Captioned Item' Macro window is displayed.

 

 

5. Enter the following details and click Insert.

a. Caption name

b. (Optional) Anchor name

c. (Optional) Caption

d.  (Optional)Horizontal Alignment

e. (Optional)Position

 

 

To edit a Captioned Item, perform the following:

 1. Select the macro block and click Edit. The Edit 'Captioned Item' 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 Captioned Item, select the macro block and click Remove button. The block is deleted.