Generating HTML documents

You can use IBM® Rational® Rhapsody® ReporterPLUS template to generate an HTML document. You can specify image files for model elements and other output options for your document.

In this step, use the same template and model to create an HTML document. Keep in mind the following behavior when generating HTML documents:

If theIBM Rational Rhapsody ReporterPLUS template has page breaks (as the GetStarted template does), the product creates a separate .html file for each page and adds one or both of the following:

By default, Rational Rhapsody ReporterPLUS creates a subdirectory named pix in the directory you specify for the HTML files and puts the graphics in it. However, you can specify a different location for graphics using an absolute or relative path.

Associating an image file with a model element

IBM Rational Rhapsody allows you to associate an image file with a model element. This image can then be used to represent the element in diagrams in place of the standard graphic representation.

To associate an image file with a model element, follow these steps:

  1. Right-click the model element in the browser.
  2. Select the Add Associated Image menu option.
  3. Select the appropriate image file for the model element.

Specifying HTML options

To define the HTML characteristics for the generated report, follow these steps:

  1. Select View > Default Document Properties. The HTML tab displays the options you can set for your HTML documents.
  2. In the Navigation section of the HTML tab, make sure Table of contents is selected (it is the default setting), and select Back/next arrows (which lets you see both types of navigation).
  3. Click OK.

Generating an HTML Document

To generate the HTML file, follow these steps:

  1. Select Edit > Generate Document. The Generate Document dialog box opens.
  2. Select a drive and folder, and type a name for the document.
  3. In the Save as type list, select HTML Page.
  4. Click Generate.

IBM Rational Rhapsody ReporterPLUS generates the document, opens your default browser, and displays the first page. Click the headings in the contents frame or click the next and back buttons to view other pages in the document.

Note: If you have an older browser and selected the Support older browsers option in the Default Document Properties dialog box, you see a message stating that a newer version of the browser yields better results, and suggesting several options. Selecting the non-resizable table of contents creates a dynamic table of contents with icons, but of a fixed size. Selecting the static table of contents creates a contents frame, but it is not dynamic and does not include icons.

Displaying Icons for Stereotypes

When generating an HTML report, the generic icon for the object type in the report browser is typically displayed in the report. For example, every class in the report includes the default graphic for a class.

However, if you want to create and display customized icons for the stereotypes in your model, follow these steps:

  1. Create your own icon in a .gif file format in 16x16 pixels.
  2. Name the icon using the same name as the stereotype it represents. For example, if the stereotype is "Car," the icon name must be "Car.gif."
  3. Add your new graphic to the icons.zip file located in your Rational Rhapsody installation ofRational Rhapsody ReporterPLUS (for example, <Rhapsody installation path>\reporterplus).
  4. Generate the HTML report with your icons.

Feedback