This macro helps you to caption content. The caption numbers are auto-incremented according to the type of content. For example figures, and tables.
| Info |
|---|
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:
The following table provides you with a description of the parameters:
Parameter Name | Default | Mandatory | Description |
|---|
Caption name | Figure | ✅ | 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 withthe Caption name as a table is auto-numbered based on the position of the content.
|
Anchor name | ❌ | ❌ (With constraints) | The name allows you to link the content to another section or a page. |
Caption | ❌ | ❌ | 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 | ❌ | Choose the horizontal alignment for the content from the drop-down menu. The following are the available alignment options: |
Position | Bottom | ❌ | Choose the position of the caption from the drop-down menu. The following are the available position options: |
| Panel |
|---|
|
Working with Parameters |
| Status |
|---|
| colour | Yellow |
|---|
| title | Example 1 |
|---|
|
| Expand |
|---|
| title | 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):
 |
| Status |
|---|
| colour | Yellow |
|---|
| title | Example 2 |
|---|
|
| Expand |
|---|
| title | 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
 |
| Status |
|---|
| colour | Yellow |
|---|
| title | example 3 |
|---|
|
| Expand |
|---|
| title | 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
| Info |
|---|
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. |
|
| Panel |
|---|
|
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.
Caption name (Optional)
Anchor name (Optional)
Caption (Optional)
Horizontal Alignment (Optional)
PositionTo caption text content, enter the text in the Insert text box.
To caption figures and tables, leave the Insert text box blank.
| Panel |
|---|
|
Editing ‘Captioned Item’ Macro |
To edit a Captioned Item, perform the following:
| Info |
|---|
You must be in the Edit mode to edit a macro block. |
Select the macro block and click the
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.
| Panel |
|---|
|
Deleting ‘Captioned Item’ Macro |
To delete a Captioned Item, select the macro block and click button. The block is deleted.
| Info |
|---|
You must be in the Edit mode to delete a macro block. |