Title Pages, Tables of Contents, Lists of Figures, Tables, and Captions

Generate a title page, a table of contents, or lists of figures, tables, or other report elements

You can use Report API reporters to generate a title page and a table of contents in a report. You can also use reporters to generate lists of the captions or titles of images, tables, and other report elements, such as equations.

Classes

`mlreportgen.report.TitlePage`	Title page reporter
`mlreportgen.report.TableOfContents`	Table of contents reporter
`mlreportgen.report.ListOfFigures`	List of figures reporter (Since R2020b)
`mlreportgen.report.ListOfTables`	List of tables reporter (Since R2020b)
`mlreportgen.report.ListOfCaptions`	List of captions reporter (Since R2020b)
`mlreportgen.report.TextFile`	Text file reporter (Since R2023a)
`mlreportgen.dom.TOC`	Create placeholder for generating table of contents
`mlreportgen.dom.LOF`	List of figures (Since R2020b)
`mlreportgen.dom.LOT`	List of tables (Since R2020b)
`mlreportgen.dom.LOC`	List of captions (Since R2020b)
`mlreportgen.dom.Leader`	Leader character for PDF output

Topics

Create Title Pages
Add a title page to your report.
Create Tables of Contents
Add a table of contents to your report.
Create Lists of Figures and Tables in Report API Reports
Add a section for a list of figures or tables to a report.
Create Lists of Captions and Titles of Related Report Elements in Report API Reports
Add a section to a Report API report for a list of related report elements, such as equations.
Create Lists of Figures, Tables, or Other Report Elements in DOM API Reports
Add a list of figures, tables, or other report elements, such as equations, to a report.
Update Tables of Contents and Generated Lists in Word Documents
Update a Word document to generate the entries in a table of contents or list of figures, tables, or captions.

Troubleshooting

Table of Contents or Generated List Is Empty in a Word Report

Troubleshoot an empty table of contents or list of figures, tables, or captions.