Captioned Item Macro (Cloud)

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
Caption name	Figure	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	None	No (With constraints)	The name allows you to link the content to another section or a page. 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	Center	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

To change parameter configuration, refer Configuration.

Working with Parameters

EXAMPLE 1

Caption name: figure, Anchor name: default, caption: default, Horizontal alignment: default, Position: default

This will display the reference in the following format:

Caption name (number):

EXAMPLE 2

Caption name: figure, Anchor name: default, caption: Reading book in the garden, Horizontal alignment: default, Position: default

This will display the reference in the following format:

Caption name (number): Caption

EXAMPLE 3

Caption name: figure, Anchor name: book, caption: Reading book in the garden, Horizontal alignment: default, Position: top

This will display the reference in the following format:

Caption name (number): Caption

The anchor value has no effect on the format, but it must be specified if you want to refer to the image in a different section or page. For more information, refer Caption Reference.

Creating ‘Captioned Item’ Macro

To create a Captioned Item, perform the following steps:

Create a new page or go to Edit the page where you want to create caption.
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.
Select Captioned Item and click Insert. The Insert 'Captioned Item' Macro window is displayed.
Enter the following details and click Insert.

For more information, refer Parameters.

a. Caption name

b. (Optional) Anchor name

c. (Optional) Caption

d. (Optional)Horizontal Alignment

e. (Optional)Position

To caption text content, enter the text in the Insert text box.

To caption figures and tables, leave the Insert text box blank.

Editing ‘Captioned Item’ Macro

To edit a Captioned Item, perform the following:

You must be in the Edit mode to edit a macro block.

Select the macro block and click the edit button. The Edit 'Captioned Item' Macro window is displayed.
You can change any of the parameters that you want to change and then click the Save button.

Deleting ‘Captioned Item’ Macro

To delete a Captioned Item, select the macro block and click remove button. The block is deleted.

You must be in the Edit mode to delete a macro block.