Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This macro displays a list of all the equations captions that are created using the LaTex Math Block Caption Item macro. You can create them on the same page or a different page.

Info

To work with the Table of Figures (Captioned Item), you must install the Numbered Caption application. For more information, see Installation.

Panel
panelIconId2757
panelIcon:exclamation:
panelIconText
bgColor#FFEBE6

You must specify the Anchor in the Caption Item macro to generate the list of equations using the Table of Figures (Captioned Item) macro.

...

Table of Contents
minLevel1
maxLevel7

panelIconId
Panel
ca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText:number_caption:
bgColor#EAE6FF#FFFFFF

Parameters

The following table provides you with a description of the parameters:

Parameter Name

Default

Mandatory

Description

Caption name

All

No

If you want to list a specific type of content, such as a table, enter the caption name.

Note

This is a case-sensitive parameter.

Page

Current

Page

page

(With Constraints)

Select No

Enter the name of the page from the drop-down listwhich you want to refer the content from. If you want to refer to use the equations content from the current page leave it blank.

Include children

Unchecked

No

Check this option to include the equations caption(s) in the list from the child page(s).

Info

This includes the equationcaption(s) from the selected parent page's child page(s).

Show anchor

Check this option to display the Anchor name in the hyperlink text

.

Info

To change parameter configuration, refer to Configuration.

 

panelIconId
Panel
ca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText:number_caption:
bgColor#EAE6FF#FFFFFF

Working with Parameters

The following examples provide you with how to work with the parameters:

Status
colourYellow
titleEXAMPLE 1

Image Removed
Expand
titleCaption name: default; Page: Defaultdefault; Include children: Unchecked; Show anchor: Unchecked
unchecked

This displays list from the current page.

Image Added

Status
colourYellow
titleEXAMPLE 2

Image Removed
Expand
titleCaption name: default; Page: Selecteddefault; Include children: Unchecked; Show anchor: Unchecked
: checked

This displays list from the current page and the respective child page(s).

Format:

Caption name (number): Caption text (Page name)

Image Added

Status
colourYellow
titleEXAMPLE 3

Image Removed
Expand
titleCaption name: default; Page: Selectedselected; Include children: Unchecked; Show anchor: Checked
unchecked

This displays list from the selected parent page.

Format:

Caption name (number): Caption text (Page name)

Image Added

Status
colourYellow
titleEXAMPLE 4

Image Removed
Expand
Panel
titleCaption name: default; Page: Defaultselected; Include children: Checked; Show anchor: Checked

 

panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText:number_caption:
bgColor#EAE6FFchecked

This displays list from the selected parent page and the respective child page(s).

Format:

Caption name (number): Caption text (Page name)

Image Added

Status
colourYellow
titleEXAMPLE 5

Expand
titleCaption name: specified (Figure); Page: default; Include children: unchecked

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)

Image Added

 

Panel
bgColor#FFFFFF

Creating Table of Figures (Captioned Item) Macro

To create a Table of Figures (Captioned Item), Perform the following steps:

...

Status
colourPurple
title2.
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.

...

Status
colourPurple
title3.
Select Table of Figures (Captioned Item) and Click Insert. The Insert Table of Figures (Captioned Item)’ window is displayed.

...

Status
colourPurple
titleA
(Optional) Page Caption name

Status
colourPurple
titleB
(Optional) Include children Page

Status
colourPurple
titleC
(Optional) Show anchor Include children

Info

For more information, refer Parameters.

 

:number_caption:
Panel
panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText
bgColor#EAE6FF#FFFFFF

Editing Table of Figures (Captioned Item)

To edit a Table of Figures (Captioned Item) perform the following:

...

Status
colourPurple
title1.
Select the math block and click the Edit button. The Edit Table of Figures (Captioned Item)’ Macro window is displayed.

...

Status
colourPurple
title2.
You can change any of the parameters that you want to change and click Save.

 

:number_caption:
Panel
panelIconIdca67b37b-d17a-40e7-8f28-b8fdae9705cf
panelIcon:number_caption:
panelIconText
bgColor#EAE6FF#FFFFFF

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.

...