MATLAB Report Generator

Getting Started

What Is the Report Generator?

Two Report Generator Packages

Multiple Report Formats

Report Generator Overview

Related Products

Generating a Report

Using a Standard Setup File

Generating and Viewing the Report

Component Descriptions

What's in This Manual

Typographical Conventions

Generating a Report

Overview of Report Generation Methods

Using the Command Line To Generate a Report

Using the Setup File List To Generate a Report

Using the Setup File Editor To Generate a Report

Getting Started with the Setup File Editor

Elements of the Setup File Editor

Report Generation

Specifying the Report Output

Report File Directory

Report Filename

Report Format and Stylesheets

Viewing and Printing Your Report

Autosaving the Setup File

Regenerating Images

Report Description

Setting the Generation Status Update Priority Level

Converting a Generated Report Into Another Format

Working with the Report Conversion UI

Working from the Command Line

Creating Log Files

Editing Component Attributes

Introduction

Displaying and Editing Component Attributes

Undoing an Attribute Edit

The Figure "For" Loop Component

Using the Handle Graphics Figure "For" Loop: A Tutorial

Starting the Tutorial

Creating Handle Graphics Figures

Understanding Important Handle Graphics Concepts

Tutorial Figure Summary

Editing the Figure "For" Loop Component

Report Generation

Choosing Figures to Loop On

Looping on the Current Figure

Looping on All Visible Figures

Looping on Figures with Certain Tags

Tutorial Summary

Property Table Components

Opening the Figure Property Table Component Attribute Page

Selecting a Table

Displaying Property Name/Property Value Pairs

Putting Text into a Table Cell

Editing the Table Title

Adding, Replacing, and Deleting Properties to a Table Cell

Displaying or Hiding Table and Cell Borders

Adding and Deleting Columns and Rows

Resizing Columns

Zooming and Scrolling

Property Table Summary

Building and Editing the Setup File

Building a Setup File with the Setup File Editor

Components

Setup File Editor

Setup File Outline

Adding a Component

Getting Help on a Component

Deleting a Component

Activating a Component

Deactivating a Component

Moving a Component

Cutting, Copying, and Pasting a Component

How to Create Your Own Components

Creating Components

Why Create Your Own?

What's Involved in Creating Components

Starting the Component Creation Wizard

Overview of Tutorials

Tutorial: Creating a Component

Entering Component Category Information

Choosing the Component Category

Specifying the Component Category ID

Specifying the Component Category Name

Looking at the New Component Category Page

Creating the Component Name

Naming the Component

Specifying the Component Function Name

Specifying the Parent Directory

Specifying the Component Description

Subcomponents

Looking at the New Component Name Page

Creating Component Attributes

Component Attribute Tutorial Task 1

Specifying the Field Name

Specifying the Data Type

Setting the Default Value

Setting the Control Type

Specifying the Attribute Name

Looking at the New Component Attributes Page

Creating Another Attribute

Component Attribute Tutorial Task 2

Creating Component Methods

Creating a Custom Attributes Method

Creating a Custom Outlinestring Method

Reviewing All Component Information

Creating and Verifying the Component

Tutorial: Editing and Running the New Component

Tutorial Activities

Editing a New Component

Editing the Execute Method

Editing execute.m to Insert Text Output into the Report

Using the New Component

Creating a New Attribute

Creating Another Attribute

Changing a Previously Created Attribute

Changing the Outline String

Running the New Component

Editing execute.m to Insert a Figure into the Report

The Report Created by the Figure Random Plot Component

Summary

Components -- By Category

Report Options

Formatting Components

Cell Table

Chapter/Subsection

Image

Link

List

Paragraph

Text

Title Page

Handle Graphics Components

Figure "For" Loop

Figure Property Table

Graphics Figure Snapshot

Graphics Object Name

Handle Graphics Parameter

Logical and Flow Components

<if> Else

<if> Elseif

For Loop

Logical If

<if> Then

While Loop

MATLAB Components

Evaluate MATLAB Expression

Insert Variable

MATLAB/Toolbox Version Number

Variable Table

Report Generator Components

Comment

Empty Component

Import File

Nest Setup File

Stop Report Generation

Time/Date Stamp

Simulink Components

Block Automatic Property Table

Block Execution Order

Block Loop

Block Property Table

Block Type: Bus

Block Type Count

Block Type: Documentation

Block Type: Look-Up Table

Block Type: Scope Snapshot

Model Change Log

Model Functions

Model Loop

Model Property Table

Model Simulation

Model Variables

Object Linking Anchor

Object Name

Object Property

Object Summary Table

Signal Loop

Signal Property Table

System Filter

System Hierarchy

System Loop

System Property Table

System Snapshot

Stateflow Components

Chart Loop

Stateflow Linking Anchor

Stateflow Name (Chart)

Object Report

Object Summary Table

Property Table

Stateflow Snapshot (chart)

Stateflow Loop

Fixed-Point Components

Fixed-Point Block Loop

Fixed-Point Logging Options

Fixed-Point Property Table

Fixed-Point Summary Table

Components -- Alphabetical List


 Getting Started