Generating a Report (Report Generator)

Report Generator

Using the Setup File Editor

You can use the Setup File Editor to view and modify your setup files and generate reports from these files. The setup file establishes the framework for a report and contains information about:

Components included in the report and their relationships
Report output format and style sheet used
Name and location of the report file

Getting Started With the Setup File Editor

To open the Setup File Editor, type setedit in the MATLAB command window; this opens a new (empty) setup file. If you type setedit <setupfilename>, the Setup File Editor opens, displaying the setup file for that report. For example, if you type setedit magic-square, the following window will appear.

Elements of the Setup File Editor

Setup File Outline

The outline of the current setup file is in the left pane of the window. The outline shows all of the components in the current setup file. Components are self-contained, modular elements that control the report generation process and insert elements into a report.

Some components can contain other components, which are then called subcomponents or child components. Subcomponents or child components are shown indented under their parent components. Components and the relationships between child and parent components are discussed in Chapter 6.

Tab Dialog

The right pane of the setup file window contains three tabs:

The Options tab lets you set report output options and change component attributes.
The Add Components tab lets you add components to the outline.
The Generation Status tab shows you the status of the current generation process.

The sections that follow describe these tabs in more detail.

Menu Bar

The Setup File Editor also contains a menu bar with the following menus:

The File menu lets you:
The Edit menu lets you:

Chapter 4 discusses Edit actions

The Window menu lets you:
The Help menu lets you go to the Report Generator Help (this manual) or go to the Setup File Editor Help ("Using the Setup File Editor" in this chapter).

Generating a Report

To generate a report using the Setup File Editor, click on the Report button, which is located under the setup file outline in the Setup File Editor. You can also select Report from the File menu. A report containing the components listed in setup file outline will be generated on any M-file, Simulink model, or Stateflow model.

While the report is in the process of generating, the Report button changes to the Stop button and all other controls (buttons and menus) are inactive. In addition, as each component executes, it is highlighted in the setup file outline.

Report Generation Cleanup

After the report is finished generating, the Report Generator closes all images, models, Stateflow windows, and Target Language Compiler™ (TLC) handles that were opened in the report generation process.

Halting Report Generation

During report generation, the Report button changes to the Stop button. To stop report generation, click on the Stop button, which is located under the setup file outline in the Setup File Editor.

[ Previous | Help Desk | Next ]