This macro displays a list of all the captions that are created using the Caption Item macro. You can create them on the same page or a different page.
To work with the Table of Figures (Captioned Item), you must install the Numbered Caption application. For more information, see Installation.
You must specify the Anchor in the Caption Item macro to generate the list of equations using the Table of Figures (Captioned Item) 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 |
|---|---|---|---|
Caption name | All | ❌ | If you want to list a specific type of content, such as a table, enter the caption name. This is a case-sensitive parameter. |
Page | Current page | ❌ | Enter the name of the page from which you want to refer the content from. If you want to refer to content from the current page leave it blank. |
Include children | ❌ | ❌ | Check this option to include the caption(s) in the list from the child page(s). This includes the caption(s) from the selected parent page's child page(s). |
To change parameter configuration, refer to Configuration.
Working with Parameters
The following examples provide you with how to work with the parameters:
EXAMPLE 1
This displays list from the current page.
EXAMPLE 2
This displays list from the current page and the respective child page(s).
Format:
Caption name (number): Caption text (Page name)
EXAMPLE 3
This displays list from the selected parent page.
Format:
Caption name (number): Caption text (Page name)
EXAMPLE 4
This displays list from the selected parent page and the respective child page(s).
Format:
Caption name (number): Caption text (Page name)
EXAMPLE 5
This displays list from the selected parent page and the respective child page(s) for the specified caption name.
Format:
Caption name (number): Caption text (Page name)
Creating Table of Figures (Captioned Item) Macro
To create a Table of Figures (Captioned Item), Perform the following steps:
1. Create a new page or go to Edit, the page where you want create a list of equations.
2. Click the + icon and search for the Table of Figures (Captioned Item) macro.
(or) you can type { caption, the list with caption macro suggestions is displayed, and you can select the Captioned Item macro.
3. Select Table of Figures (Captioned Item) and Click Insert. The Insert ‘Table of Figures (Captioned Item)’ window is displayed.
4. Enter the following parameters:
A (Optional) Caption name
B (Optional) Page
C (Optional) Include children
For more information, refer Parameters.
Editing Table of Figures (Captioned Item)
To edit a Table of Figures (Captioned Item) perform the following:
You must be in the Edit mode to edit a macro.
1. Select the block and click the Edit button. The Edit ‘Table of Figures (Captioned Item)’ Macro window is displayed.
2. You can change any of the parameters that you want to change and click Save.
Deleting Table of Figures (Captioned Item)
To delete Table of Figures (Captioned Item), select the block and click the Remove button. The block is deleted.
You must be in the Edit mode to delete a macro.