Store 
| Products & Services | Solutions | Academia | Support | User Community | Company |
 |
Download Product Updates | | |  |
Get Pricing | | | |
Trial Software |
| Documentation → Simulink Report Generator |
| Products & Services | Solutions | Academia | Support | User Community | Company |
|
Download Product Updates | | | |
Get Pricing | | | |
Trial Software |
| Documentation → Simulink Report Generator |
| Contents | Index |
| Learn more about Simulink Report Generator |
| On this page… |
|---|
Setting the Report File Folder Converting English Strings to Other Languages |
Specify report output settings using the Preferences pane. To open this pane, click File > Preferences. A list of available options appears in the following table.
Option | Purpose |
|---|---|
| Format ID | Specify the report output format. Choices include Acrobat (PDF), Rich Text format, and Word document. The default is Web (HTML). |
| Extension | Automatically sets the file extension of the report file according to the value specified for Format ID. The default is html. |
| Simulink Images | Specify the format for Simulink images to include in the report. The default is PNG 24-bit image. |
| Stateflow Images | Specify the format for Stateflow charts to include in the report. The default is PNG 24-bit image. |
| HG Images | Specify the format for Handle Graphics® images to include in the report. The default is PNG 24-bit image. |
| View command | Specify the MATLAB command you want to use to view the report. |
| Visible in Report Explorer | Deselect this check box to make the current output format unavailable in the Report Explorer Interface. For example, if your specified report format is Word document and you deselect this check box, then the Microsoft Word document format is no longer available for reports created using the Report Explorer. |
| Use version 1.x environment | Choose this option to use previous versions of MATLAB Report Generator and Simulink Report Generator interfaces. For more information, see Using Legacy Interfaces. |
| 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. |
Choose a folder to which you have write privileges, to store the report file. A list of options appears in the following table.
Folder | Option |
|---|---|
The same folder as the report template | Same as report template |
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 in the MATLAB Report Generator documentation.
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.
Choose a file name for the report file, using the options listed in the following table.
File Name | Option |
|---|---|
The same file name as the report template | Same as report template (default) |
A file name different from the report template name | Custom. Enter the name of the report. |
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 in the MATLAB Report Generator documentation.
Choose the report output format in the File format text box. For example, if you want to use Microsoft Word, choose Word document or Rich Text Format.
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) | Produces a PDF that you can view using Adobe Acrobat Reader software | PDF (see PDF Stylesheets) |
Web browser | Web (HTML) (default) | Use for publishing on the World Wide Web | Web (see Web Stylesheets) |
Word processor | Rich Text Format (RTF) or Word Document | Compatible with most word-processing packages, including Microsoft Word software | Print (see RTF (DSSSL Print) and Word Stylesheets) |
DocBook | DocBook (XML) | Produces a report in DocBook format | N/A |
Tip To create and use customized styles, see Creating Custom Stylesheets. |
PDF 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 | Chapters and sections are not numbered |
Numbered Chapters & Sections | Chapters and sections are both numbered |
Paginated Sections | Sections are printed with page breaks |
Custom Header | Lets you specify custom headers and footers |
Custom Titlepage | Lets you specify custom title page content and presentation |
Logo stylesheet for PDF | Lets you specify a logo, such as your company logo, in the header |
Verbose Print | Lets you specify advanced print options |
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 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 | Chapters and sections are not numbered |
Numbered Chapters & Sections | Chapters and sections are both numbered |
Note Some Web and Print stylesheets include an automatically generated list of titles. The list of titles includes a list of table titles and a list of figures with titles. |
To view your report after generation:
To view the report automatically, select the View report after generation check box in the Generation Options section in the Properties pane on the right. When report generation is complete, the viewer associated with the report output format displays the report.
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.
To print your report, select the Print option from the viewer.
Versions 2.0 and later of the MATLAB Report Generator and Simulink Report Generator software use the system language settings through the Sun™ Java™ interface; therefore, they should use the language specified on your system.
Alternatively, you can change the language directly in Java from the MATLAB command line. The following example sets the language to Italian:
java.util.Locale.setDefault(java.util.Locale.ITALY)
Alternatively, you can set the preferred language directly in your .rpt file:
Right-click the Report component and select Send to Workspace.
This displays the properties of the report, which are stored in the variable ans. Access the report's Language property from the command line through this variable. By default, Language is auto, which indicates that the system's default language is in use.
Override the default value of Language by setting this property to your desired language; for example, en for English or it for Italian.
To automatically save the report template before you generate a report, select Auto save before generation from the Generation Options section of the Properties pane on the right.
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. To ensure that a report reflects compiled values, select the Compile model to report on compiled information option. 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. |
By default, the Regenerate Simulink and Stateflow Images option in the Generation Options section of the Properties pane on the right is cleared. As a result, previously generated images are not regenerated each time you generate a report, so reports generate faster. If you make changes that affect a generated image, select this option.
Use the Report Description field in the Properties pane on the right to record notes and comments about your report template. This text appears in the Properties pane on the right when you select a report template in the Outline pane on the left.
 | Generating Reports | Converting XML Documents |  |
Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.
| © 1984-2009- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |
