Generating a Report (Report Generator)

Report Generator

Specifying the Report Output

The Options tab for the Report component contains report output preferences.

Specifying the Directory for the Report File

Choose the appropriate directory for the report file according to the table below. Make sure you have write privileges for that directory.


To save your report in...	Select this option...
The same directory as the setup file	Same as setup file
The present working directory	Present working directory
Another directory	Specify a directory in the Other text box or use the browse button (...)

Naming the Report File

Choose the appropriate filename for the report file according to the table below.


If you want...	Select this option...
Your report have the same filename as the setup file	Same as setup file (this is the default report name)
Your report to have a filename that is different than the setup file name	Other; then enter the name of the report in the text box
To prevent writing over a report with the same filename (e.g., `report1.html`, `report2.html`,...)	If report already exists, increment to prevent overwriting

Report Format and Stylesheets

You can choose the report output format in the drop box on the left in this section. You should choose the output format according to the software or viewer you want to use to view the report. For example, if you want to use Microsoft Word 95, you should choose RTF 95.

Specify the stylesheet in the drop box on the right in this section. A stylesheet formats the report in terms of fonts, headings, etc. Stylesheets depend on the output format, that is, certain stylesheets are available for certain output formats. Each output format has a default stylesheet.

The table below shows which output format to use with different viewers or software as well as which stylesheets are available for use with each output format.


If you want to use...	Select this output format...	Stylesheet Options
An HTML viewer	web (HTML) (default)	Web (see "Web Stylesheets" later in this chapter)
SGML	Doc Book (SGML)	None (no transform)
Microsoft Word 95	Rich Text Format (RTF) 95	Print (see "Print Stylesheets" later in this chapter)
Microsoft Word 97	Rich Text Format (RTF) 97	Print
XML parser	Flow Object Tree (XML)	Print

If you want to create a report in multiple formats without regenerating your report each time, see "Converting a Generated Report Into Another Format" later in this chapter.

Report Output Format Descriptions

web (HTML) is the default output format. It is used for publishing on the World Wide Web.
Doc Book (SGML) produces source SGML. The SGML source code is always generated in addition to the output format you choose.
Rich Text Format (RTF) 95 is used with Microsoft Word 95 or any Word 95 viewer.
Rich Text Format (RTF) 97 is used with Microsoft Word 97 or any Word 97 viewer.
Flow Object Tree (XML) is the XML representation of low-level DSSSL formatting constructs. It can be parsed by an XML parser.

Web Stylesheets

Web Stylesheet
Description

Single-Page Web
HTML on a single page

Multi-Page Web
HTML with each chapter on a separate page

Single-Page Simple
Suppresses title page, table of contents, list of titles

Single-Page Unnumbered Chapters & Sections
Chapters and Sections are not numbered

Single-Page Numbered Chapters & Sections
Chapters and Sections are both numbered

Multi-Page Simple
Suppresses title page, table of contents, list of titles

Multi-Page Unnumbered Chapters & Sections
Chapters and Sections are not numbered

Multi-Page Numbered Chapters & Sections
Chapters and Sections are both numbered

Web Stylesheet	Description
Single-Page Web	HTML on a single page
Multi-Page Web	HTML with each chapter on a separate page
Single-Page Simple	Suppresses title page, table of contents, list of titles
Single-Page Unnumbered Chapters & Sections	Chapters and Sections are not numbered
Single-Page Numbered Chapters & Sections	Chapters and Sections are both numbered
Multi-Page Simple	Suppresses title page, table of contents, list of titles
Multi-Page Unnumbered Chapters & Sections	Chapters and Sections are not numbered
Multi-Page Numbered Chapters & Sections	Chapters and Sections are both numbered

Note that all Web and Print stylesheets include a list of titles, unless otherwise shown in table. The list of titles includes a list of (titled) tables and a list of (titled) figures.

Print Stylesheets

Print Stylesheet
Description

Standard Print
Displays title page, table of contents, list of titles

Unnumbered
Chapters & Sections
Chapters and Sections are not numbered

Numbered
Chapters & Sections
Chapters and Sections are both numbered

Compact Print
Minimizes white space to reduce page count

Compact Simple Print
Minimizes page count, suppresses title, table of contents, list of titles

Large Type Print
Uses 12 point font (slightly larger than "Standard Print")

Simple Print
Suppresses title page, table of contents, list of titles

Very Large Type Print
Uses 24 point font and landscape paper orientation

Print Stylesheet	Description
Standard Print	Displays title page, table of contents, list of titles
Unnumbered Chapters & Sections	Chapters and Sections are not numbered
Numbered Chapters & Sections	Chapters and Sections are both numbered
Compact Print	Minimizes white space to reduce page count
Compact Simple Print	Minimizes page count, suppresses title, table of contents, list of titles
Large Type Print	Uses 12 point font (slightly larger than "Standard Print")
Simple Print	Suppresses title page, table of contents, list of titles
Very Large Type Print	Uses 24 point font and landscape paper orientation

Viewing and Printing Your Report

You can use the View report after generating option to view your report. Click on Edit... in the Generation Options section and then select this option, or click on the corresponding button in the Setup File Editor.

Note that when this option is not selected, the button appears grayed out. When report generation is complete, the viewer associated with the report format output you chose is launched, displaying the report.

If you want to print your report, select the print option from the viewer.

Autosaving the Setup File

To automatically save the setup file before you generate a report, select Save setup file on generation. Click on Edit... in the Generation Options section and then select this option, or click on the corresponding button in the Setup File Editor.

Note that when this option is deselected, the button appears grayed out.

Regenerating Images

By default, the Regenerate Images button is selected. If you deselect this option, previously generated images (Simulink, Stateflow, etc.) will not be regenerated each time you generate a report; images from the previous generation will be used. This results in faster report generation. Use this option only if you have not made any changes that could affect these images.

Click on Edit... in the Generation Options section and then select this option, or click on the corresponding button in the Setup File Editor.

Note that when this option is deselected, the button appears grayed out.

Report Description

Use the Report Description field to makes notes and comments on your setup file. This description appears at the bottom of the Setup File List.

[ Previous | Help Desk | Next ]