Report Generation Settings

Report Generator Settings Pane

To set defaults for report generation options, use the Report Generator Settings pane. You can override these settings with the Report Options dialog box or with individual components.

To specify report generation options for a specific report, in the Report Explorer, use the Report Options dialog box. For details, see Select Report Generation Options.

To open the Report Generator Settings pane, use one of these approaches:

In the Report Explorer, select File > Preferences.
From the MATLAB^® Toolstrip, in the Home tab, in the Environment section, select Settings > Report Generator.

Report Generator Settings pane

File Format and Extension

To specify the default file format for reports, use the Format ID setting. The default setting is web (HTML). You can select from a range of file formats, such as PDF or Microsoft^® Word.

If you have Adobe^® Acrobat^® and acrobat.exe is on your system path, you can set it as the default PDF format. Select a PDF format as the Format ID. Then, replace the command in Command to view with system("acrobat %<FileName>");

The Extension setting reflects the standard file extension for the file format specified with the Format ID setting. You can change the extension.

Image Formats

To set the default image formats associated with the output format for a report, use the following settings.

Setting	Purpose
Simulink Images	Specify the format for Simulink^® images to include in the report.
Stateflow Images	Specify the format for Stateflow^® charts to include in the report.
HG Images	Specify the format for Handle Graphics^® images to include in the report.

Note

The default settings for image formats should work in most viewing environments. However, some image formats do not display in some viewing environments.

Several components, such as the Figure Snapshot component, include an option for specifying the image format. The component setting overrides the image format setting.

Report Viewing

To control how you view a generated report, you can set the following settings.

Setting	Purpose
View command	Specify the MATLAB command you want to use to view the report. Each file format has an associated default view command setting. You can modify the view command (for example, to support the use of a system browser).
Animate Report Explorer when generating reports	Select this check box if you want components in the Outline pane to be animated as the report generates. This box is selected by default. To speed up the report generation processing, clear this setting.

Setting

Purpose

View command

Specify the MATLAB command you want to use to view the report.

Each file format has an associated default view command setting. You can modify the view command (for example, to support the use of a system browser).

Animate Report Explorer when generating reports

Select this check box if you want components in the Outline pane to be animated as the report generates. This box is selected by default.

To speed up the report generation processing, clear this setting.

Reset to Defaults

To reset the Report Generator™ settings under Output Format Options, click Reset to Defaults. Resetting to defaults does not affect the options under Settings.

Edit HTML Command

Enter the command to use to open HTML or PDF template files from the Report Explorer's Document Conversion Template Editor (see Report Templates). The default command opens the files in the MATLAB text editor.

To set this setting to an operating system command, use the MATLAB system command. Use the file name token %<FileName> to specify where in the command the template editor inserts the path to the file to edit. Make sure that the command is on your system path.

This example shows a command that opens Report Generator HTML-based template files in the notepad++ application. The ampersand character (&) executes the command in the background.

system("notepad++  %<FileName> &");