Report Setups

A report setup is a set of MATLAB® objects, called components, that specifies the content and form of a report.

The MATLAB Report Generator™ provides a setup editor, called the Report Explorer, that you use to create and edit report setups.

Once you create a setup, you can generate a report from it, using the Report Explorer or MATLAB commands.

Setup Hierarchy

A report setup has a hierarchical structure that generally mirrors the structure of the type of report that it defines.

For example, a report typically has a title page and one or more chapters. Each chapter contains one or more sections, each of which contains one or more paragraphs, figures, tables, lists, etc. A report setup typically comprises components that correspond to these structural elements of a report.

In a report setup, child-parent relationships among the components correspond to the containment relationships among the structural elements of the report. In particular, all setups contain a root component that serves as the ancestor for all other components in the setup. The root component also specifies the setup name and report generation options, such as the document type of the generated report (for example, HTML or PDF) and the path for the generated report. The root component typically parents a title page component and one or more chapter components that in turn parent one or more section components that parent one or more paragraph, figure, table, and list components.

Setup Files

The report generator stores setups in files called setup files. The name of a setup file consists of the name of the setup that it stores followed by the file extension .rpt. For example, the name of the setup file for a setup named myreport would be myreport.rpt.

Create a Report Setup

To create a report setup:

Once you create a template, you can execute it to generate an instance of the type of report that it defines.

Was this topic helpful?