Launching documentation generation

The document work product

The document work product is used to add specific information related to the documentation (title, author) and to generate the information in the desired format. Figure 7 illustrates the creation of a document work product.

Generation steps

Figure 7. Creating a document work product

Steps:

1. Select the "TrainingSystem" package.

2. Click on the "Create a document" icon.

3. Enter the necessary information in the fields (name, title, ...).

4. Select the "analysis.us" message file.

5. Select the "Analysis" template.

6. Confirm.

Continue by right-clicking on the newly created document work product in the explorer, and running the "MDA components/Documentation/Generate" command from the context menu. This generates the documentation and automatically opens it in the editor specified at MDAC parameter level.

Note: The "Documentation/Visualize" command on a document work product can also be used to open generated documents.

HTML format

This format can be generated and visualized in UNIX and Windows.

HTML documentation can be edited by all the web explorers. Hypertext links are used to browse, using the model’s links to packages and classes.

Figure 8. An example of documentation in HTML format

"RTF" format

This format can be generated in UNIX and Windows, but can only be visualized in Windows.

Figure 9. An example of documentation in RTF format

ASCII format

This format can be generated and visualized in UNIX and Windows.

In ASCII, the result, represented in Figure 10, is noticeably less attractive.

Figure 10. An example of documentation in ASCII format

Postscript format

This format can only be generated and visualized in UNIX.

Figure 11. An example of documentation in Postscript format