Generating message set documentation as HTML

This task topic describes how to generate message set documentation as HTML.

To generate message set information as HTML:

  1. Switch to the Broker Application Development perspective.
  2. Select the message set from which you want to generate documentation as HTML.
  3. From the workbench menu, click File > New > Message Set Documentation to open the New Message Set Documentation wizard. Alternatively, right-click anywhere in the Resource Navigator then click New > Message Set Documentation on the pop-up menu.
  4. The message set that you selected is highlighted in the wizard. If this is not the message set from which you want to generate HTML, select the correct message set.
  5. Click Next to move to the next page of the wizard.
  6. Click the destination folder for the HTML documentation.
    Tip: The folder that you select must be within the project containing the message set from which you are generating the documentation. The documentation that you generate is automatically placed in a folder with the same name as the message set. If the destination folder that you choose already exists, the contents are overwritten.
  7. Create a new folder for the documentation by carrying out the following steps:
    1. Click the location for the new folder in the project hierarchy.
    2. Click Create New Folder and type a name for the new folder.
    3. Click OK.
  8. Click Finish. Your HTML documentation is generated.
  9. View the generated documentation by carrying out the following steps:
    1. In the Resource Navigator, expand the package that has exactly the same name as the message set from which you generated the documentation. This package is created as part of the documentation generation process.
    2. In the package, right-click the file index.html, then click Open With > System Editor on the pop-up menu. The generated HTML documentation opens in your system's default web browser.
Related concepts
The message model
Generate model representations
Related tasks
Working with a message set
Working with a message definition file
Working with message model objects
Working with a message category file