Documentation Center

  • Trial Software
  • Product Updates

Report Generation Options

Report Options Dialog Box

To specify report generation options for a specific report, in the Report Explorer, use the Report Options dialog box.

The Report Options dialog box in the Properties (right hand) pane of the Report Explorer.

To set defaults for report generation options that you can override with the Report Options dialog box or with individual components, use the Report Generator Preferences pane. For details, see Report Generation Preferences.

Report Output Format and Stylesheet

In the Report Explorer, in the File format text box, choose the report output format . For example, if you want to use Microsoft® Word, choose Word Document (RTF).

Each output format has a default stylesheet associated with it. Specify the stylesheet in the text box next to the File format text box.

The following table shows which output format to use with different software, and which stylesheets you can use with each output format.

Viewer

Format

Description

Stylesheets

Adobe® Acrobat® Reader

Adobe Acrobat (PDF)

Produce a PDF that you can view using Adobe Acrobat Reader software.

See PDF: Image Formats.

PDF (see PDF Stylesheets)

Web browser

Web (HTML) (default)

Use for publishing on the World Wide Web.

Web (see Web Stylesheets)

Word processor

Word Document (RTF) or Rich Text Format

Produce output that is compatible with most word-processing packages, including Microsoft Word software

See RTF: Display of Hidden Content.

Print (see RTF (DSSSL Print) and Word Stylesheets)

DocBook

DocBook (XML)

Produce a report in DocBook format

N/A

PDF: Image Formats

PDF reports only support bitmap (.bmp), jpeg (.jpg), and Scalable Vector Graphics (.svg).

The SVG format is only supported for Simulink® models and Stateflow® charts. For example, MATLAB® figures do not display in SVG when you select the SVG format for PDF reports.

RTF: Display of Hidden Content

RTF reports use placeholders (field codes) for dynamically generated content, such as page numbers or images.

On Windows® platforms, to display that content, press Ctrl-A, and then press F9.

On Linux® and Mac platforms, use the field code update interface for the program that you are using to view the RTF document.

Change the Default Output Format

In the Report Generator Preferences pane, use the Format ID preference to specify the default output format for reports.

Stylesheets

For each output format, you can choose from several stylesheets for each report output format. For details, see:

    Note:   Some Web and Print stylesheets include an automatically generated list of titles, which includes table titles and figures with titles.

PDF Stylesheets

PDF Stylesheet

Description

Default print stylesheet

Displays title page, table of contents, list of titles

Standard Print

Displays title page, table of contents, list of titles

Simple Print

Suppresses title page, table of contents, list of titles

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)

Very Large Type Print

Uses 24-point font and landscape paper orientation

Compact Print

Minimizes white space to reduce page count

Unnumbered Chapters & Sections

Uses unnumbered chapters and sections

Numbered Chapters & Sections

Numbers chapters and sections

Paginated Sections

Prints sections with page breaks

Custom Header

Lets you specify custom headers and footers

Custom Titlepage

Lets you specify custom title page content and presentation

Verbose Print

Lets you specify advanced print options

Web Stylesheets

Web Stylesheet

Description

Default HTML stylesheet

HTML on a single page

Simulink book HTML stylesheet

HTML on multiple pages; suppresses chapter headings and table of contents

Truth Table HTML stylesheet

HTML on multiple pages; suppresses chapter headings and table of contents

Multi-page Web

HTML, with each chapter on a separate page

Single-page Web

HTML on a single page

Single-page Unnumbered Chapters & Sections

HTML on a single page; chapters and sections are not numbered

Single-page Numbered Chapters & Sections

HTML on a single page; chapters and sections are numbered

Single-page Simple

HTML on a single page; suppresses title page and table of contents

Multi-page Simple

HTML on multiple pages; suppresses title page and table of contents

Multi-page Unnumbered Chapters & Sections

HTML on multiple pages; chapters and sections are not numbered

Multi-page Numbered Chapters & Sections

HTML on multiple pages; chapters and sections are numbered

RTF (DSSSL Print) and Word Stylesheets

RTF or Word Stylesheet

Description

Standard Print

Displays title page, table of contents, list of titles

Simple Print

Suppresses title page, table of contents, list of titles

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)

Very Large Type Print

Uses 24-point font and landscape paper orientation

Compact Print

Minimizes white space to reduce page count

Unnumbered Chapters & Sections

Uses unnumbered chapters and sections

Numbered Chapters & Sections

Numbers chapters and sections

Report Generation Processing

The Report Options dialog box includes several options for controlling report processing.

Option

Purpose

View report after generation

View the report automatically. When report generation finishes, the viewer associated with the report output format displays the report.

    Note:   On Linux and Macintosh platforms, the report output displays in Apache OpenOffice, which must be installed in /Applications/OpenOffice.app.

To view the report manually, browse to the location specified in the Report File Location section in the Properties pane on the right, and open the file.

Auto save before generation

Automatically save the report setup file before you generate a report.

Compile model to report on compiled information

Ensure that a report reflects compiled values.

By default, the Simulink Report Generator™ reports uncompiled values of Simulink parameters. The uncompiled values of some parameters, such as signal data types, can differ from the compiled values used during simulation.

This option causes the report generator to compile a model before reporting on model parameters. After generating the report, the report generator returns the model to its uncompiled state.

    Note:   When you select this option, whenever report generation requires simulating the model (for example, the report includes a Model Simulation component), the report generator uncompiles the model and then recompiles the model, if necessary, to report on model contents. If a report requires multiple compilations, the processing can be quite time-consuming.

    To minimize compilations, consider using separate reports to report on the contents of a model and on the results of simulating that model.

Evaluate this string after generation

Specify MATLAB code for processing to occur after the report is generated. For example, you could specify to close a model.

Output File Location

Choose a folder to store the report file. You must have write privileges for that folder.

Folder

In the Report Explorer, in the Report Options dialog box, use the Directory field to specify the name of the folder in which to store the generated report file. Specify a folder to which you have write privileges.

The following table summarizes the report file location options.

Folder

Option

The same folder as the report setup file

Same as setup file

The current working folder

Present working directory

Temporary folder

Temporary directory

Another folder

Custom.

Use the Browse button (...) to select from a list of directories.

You can use %<VariableName> notation to specify a folder in the Custom text box. For more information, see %<VariableName> Notation on the Text component reference page.

Report File Name

In the Report Explorer, in the Report Options dialog box, use the Filename field to specify a file name for the report file. Select one of the following options.

File Name

Option

The same file name as the report setup file

Same as setup file (default)

A file name different from the report setup file name

Custom.

Enter the name of the report.

You can use %<VariableName> notation to specify a file name in the Custom text box. For more information, see %<VariableName> Notation on the Text component reference page.

Increment to Prevent Overwriting

To maintain the previous version of the setup file when you save updates to the setup file, select If report already exists, increment to prevent overwriting.

Image Output File Location

Images are placed in a folder with the same name as the report file. For example, testreport.html images are placed in a folder named testreport_files.

Report Description

To record notes and comments about your report setup, use the Report Description field. This text that you enter appears in the Properties pane when you select a report setup file in the Outline pane.

Was this topic helpful?