Write the application documentation Reference Documentation

Kevin wants to use UML Designer to document its application. It exists mainly two features to help him in this tasks :

  • Documentation table from the Review viewpoint,
  • Export to HTML site or to images.

Manage comments in diagram

In UML Designer, a Comments layer is available on all the diagrams. To document his application Kevin opens the existing diagrams and activates the comments layer.

This layer provides a new section in the palette.

The following tools are available :

  • create a comment : the user selects the Comment tool in the palette and clicks on the diagram, a new UML comment is created attached to the package associated to the diagram. If the user selects an element on the diagram, the comment will be attached to the selected element. The comments are represented on the diagram as following :
  • link a comment to a semantic element : the user selects the Link comment tool in the palette and selects as source a comment and as target an element. Thias action attached the comment to the selected element. The link is represented on the diagram by a doted link :

When the layer is activated the comments are visible on the diagram.

The user can remove the comment (see Diagram editor/Editor main graphical area/Direct edit).

Comments table

Thanks to the documentation table available in UML Extensions viewpoint, a user can add and review comment on each model element easily. This representation is a table which lists all the elements available in the model sub tree and their related comment.
The first column show the element name and the second column the associated comment.
The elements should be ordered using a tree in order to get the possibility to expand and collapse some sub elements.

Export

UML Designer allows to export the defined diagrams.

HTML export

This feature allows to export all the models with their representations into an HTML site. The site displays the model explorer on the left with the model elements and their corresponding clickable representations. When selecting a model element on a representation, the site displays its properties. All the pages are generated with Acceleo templates and can easily be adapted. This features is only available in Obeo Designer and not with the Sirius based product.

Export diagrams as images

It is possible to export a diagram to an image file. To do that right-click on the diagram and choose the menu Export diagram as image or select the corresponding icon in the diagram tab-bar. After selecting the file path, the user can choose the image format and he wants to overwrite an existing file without warning. On the first export of diagram as image the name is set by default with the representation name. After there is an history to select the last export. If you do not specify the file extension, the extension is determined from the selected image format. You can choose the directory in which to create the file using the Browse button.

It is possible to export all diagram of a representations file at once. To do that, select the representations file (.aird file) and right-click on it. Then choose the menu Export diagrams as image…. On the opened pop-up select the path of the folder where the images will be exported.
The same functionality is available on every semantic elements which has representations from the Model Explorer view. In this case, only the diagrams of the selected element will be exported.