MATLAB Report Generator

Comment

Comment

Category

Report Generator

Description

The Comment component inserts a comment into the SGML source file created by the report generation process. The comment is not visible in the generated report.

This component can have children. Child components insert their output into the SGML source file, but this output appears inside comment tags and does not appear in the final report.

If you want the comment text to appear in the report, follow these steps:

1. Edit the SGML source file (the SGML source file has the same name as your report file, but has a .sgml extension). Note that you must generate a report to create the SGML source file.
2. Find the comment area in the SGML source file by locating the comment tags <-- and -->. Remove both of these tags.
3. Convert the SGML source file using the rptconvert command (see Converting a Generated Report Into Another Format for more details on the rptconvert command).

Attributes

This is the Comment component attribute page.

Note    To view a component attribute page in the Setup File Editor, select the component in the setup file outline on the left and click on the Options tab. If the component is not in the setup file outline, you must add it to the outline first. See Building and Editing the Setup File for a discussion on how to add a component to the outline.

Comment Text

Enter the comments that you want to include in the report.

Status Message

Show comment in Generation Status window

Select this option if you want to display the comment in the Generation Status tab when the report is generating.

Status message priority level

This option is only available if you select the Show comment in Generation Status window option. Select the status message priority level that is displayed during report generation. See Setting the Generation Status Update Priority Level for more information on the message priority level.

Insert anything into report?

No, but this component inserts a comment into the SGML source file, which can appear in the report.

Filename

crg_comment

Report Generator Components

Empty Component