Previous  Top  Next

Generating UML documentation

The Project | Generate Documentation... command generates detailed documentation about your UML project in HTML, Microsoft Word, or RTF formats. Note: In order to generate documentation in MS Word format, you must have MS Word (version 2000 or later) installed.

Note that you can also create partial documentation of modeling elements by right clicking an element in the Model Tree and selecting "Generate Documentation". The documentation options are the same in both cases.

Related elements are hyperlinked in the onscreen output, enabling you to navigate from component to component. Note also that documentation is also generated for included C#, Java and/or VB subprojects (profiles).

The Embed diagrams option is enabled for the Microsoft Word and RTF output options. When this option is selected, diagrams are embedded in the generated file. Diagrams are created as PNG files (for HTML), or PNG/EMF files (for MS Word and RTF), which are displayed in the result file via object links.

Split output to multiple files generates an output file for each modeling element that would appear in the TOC overview when generating a single output file e.g. a class C1 with a nested class CNest exists; C1.html contains all info pertaining to C1 and CNest as well as all their attributes, properties etc.

The Generate links to local files option allows you to specify if the generated links are to be absolute, or relative, to the output file.

The Include tab allows you to select which diagrams and modeling elements are to appear in the documentation.

Note that documenting subprojects can be disabled by deselecting the "Included subprojects" check box.

The Details tab allows you to select the element details that are to appear in the documentation.

If you intend to import XML tags text in your documentation, please de-activate the "as HTML" option under the Documentation option. (what about Word, HTML etc. in the Main tab??).

The Fonts tab allows you to customize the font settings for the various headers and text content.

The following screenshots show the generated documentation for the Bank_MultiLanguage.ump file that is included in the ...\UModelExamples directory.

The screenshot above shows the generated documentation with the diagram and element index links at the top of the HTML file. The screenshot below shows the specifics of the Account class and its relation to other classes.

Note that the individual attributes and properties in the class diagrams are also hyperlinked to their definitions. Clicking a property takes you to its definition.