Select Report Generation Options
Report Options Dialog Box
To specify report generation options for a report, in the Report Explorer, use the Report Options dialog box. The Report Options dialog box appears when you select the report from the outline view.
To set the defaults for these options, use the Report Generator preferences. For details, see Report Generation Preferences.
If you are creating a form-based report, instead use the Report Form Options dialog box. See Report Form.
Location of Report Output File
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 |
|
The current working folder |
|
Temporary folder |
|
Another folder |
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.
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 |
|
A file name different from the report setup file name |
Enter the name of the report. |
You can use
%<VariableName>
notation
to specify a file name in the
Custom text box.
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 Output Format
Under Report Output Type and Style Sheets, from the File format list, select the report output format. You can generate reports whose formatting is based on templates or based on Report Explorer style sheets.
File Formats Using Report Templates
For faster report generation, set File format to use a template. Select one of these options:
Direct PDF (from template)
HTML (from template)
— Select this option if you want your report’s table of contents to expand and collapse.Multipage HTML (from template)
— Select this option if you want the HTML report as a linked collection of HTML pages.PDF (from Word template)
Single-file HTML (from template)
— Select this option if you want your report’s table of contents to expand and collapse and want the HTML report as a single file.Word (from template)
If you select a from
template
output format, then you can
use a default template or a customized template.
For more information about using templates for
report generation, see Generate a Report Using a Template. For
information on customizing templates, see Customize Report Conversion Templates.
File Format Using Report Explorer Style Sheets
The output formats that do not include
from template
in the
name use Report Explorer style sheets for
formatting. For those output formats, select a
style sheet from the Style
Sheet list.
Viewer | Format | Description | Style Sheets |
---|---|---|---|
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 Style Sheets) |
Word processor |
| Produce output that is compatible with most word-processing packages, including Microsoft® Word software | Print (see RTF (DSSSL Print) and Word Style Sheets) |
DocBook | DocBook (no
transform) | Produce a report in DocBook format | N/A |
Tip
To create and use customized styles, see Create a New Style Sheet.
PDF: Image Formats
PDF reports support only
JPEG
(.jpg
)
and Scalable Vector Graphics
(.svg
).
The SVG format is supported only 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.
Style Sheets
For each output format, you can choose from several style sheets for each report output format. For details, see:
Note
Some Web and Print style sheets include a generated list of titles, which includes table titles and figures with titles.
PDF Style Sheets
PDF Style Sheet | Description |
---|---|
| Displays title page, table of contents, list of titles |
| Displays title page, table of contents, list of titles |
| Suppresses title page, table of contents, list of titles |
| Minimizes page count, suppresses title, table of contents, list of titles |
| Uses 12-point font (slightly larger than Standard Print) |
| Uses 24-point font and landscape paper orientation |
| Minimizes white space to reduce page count |
| Uses unnumbered chapters and sections |
| Numbers chapters and sections |
| Prints sections with page breaks |
| Lets you specify custom headers and footers |
| Lets you specify custom title page content and presentation |
| Lets you specify advanced print options |
Web Style Sheets
Web Style Sheet | Description |
---|---|
| HTML on a single page |
| HTML on multiple pages; suppresses chapter headings and table of contents |
| HTML on multiple pages; suppresses chapter headings and table of contents |
| HTML, with each chapter on a separate page |
| HTML on a single page |
| HTML on a single page; chapters and sections are not numbered |
| HTML on a single page; chapters and sections are numbered |
| HTML on a single page; suppresses title page and table of contents |
| HTML on multiple pages; suppresses title page and table of contents |
| HTML on multiple pages; chapters and sections are not numbered |
| HTML on multiple pages; chapters and sections are numbered |
RTF (DSSSL Print) and Word Style Sheets
RTF or Word Style sheet | Description |
---|---|
| Displays title page, table of contents, list of titles |
| Suppresses title page, table of contents, list of titles |
| Minimizes page count, suppresses title, table of contents, list of titles |
| Uses 12-point font (slightly larger than Standard Print) |
| Uses 24-point font and landscape paper orientation |
| Minimizes white space to reduce page count |
| Uses unnumbered chapters and sections |
| Numbers chapters and sections |
Report Generation Processing
The Report Options dialog box includes options for controlling report processing.
Option | Purpose |
---|---|
View report after generation | When report generation finishes, the viewer associated with the report output format displays the report. Opening a Microsoft Word document on a Linux or Macintosh platform calls the To view the report manually, open the file from the location specified in the Report Options for the report, under Report File Location. |
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 (Simulink Report Generator) 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. |