RTF documentation

With rich text format (RTF), you can format the text in documentation editor, such as making it bold, italic, or adding tables within the text. In addition to formatting, RTF supports users to add linkage to another model element, save documentation as template and furthermore reuse the template.

Viewing and editing the documentation of model element

To view or edit the documentation of model element, right click on the model element and select Open Specification... from the pop-up menu.

Open specification

Alternatively, click the Documentation pane after select a specific model element on the diagram pane.

Documentation pane

Documentation editor

The documentation pane is where you can describe the selected model element. With the editor's toolbar, you can format the content, save as template, reuse the existing template, add model elements and print the content.

The overview of documentation editor

 

The toolbar on documentation editor

No. Name Description 1  HTML HTML - Read and edit the real content. HTML Source - Read and edit the HTML source of content. Plain Text - Read and edit plain text of content without formatting. 2 Bold Set the highlighted text to bold. 3 Italic Set the highlighted text to italic. 4 Underline Underline the highlighted text. 5 Alignments Set the alignment of highlighted text to the left, the center or the right. 6 Ordered list Add a numbered list. 7 Un-ordered list Add a list with bullet points. 8 Font Select the font family of highlighted text. 9 Font size Select the size of highlighted text. 10 Font color Select the color of highlighted text. 11 Table Add a table. 12 Background color Select the background color of highlighted text. 13 Clear formats Clear formats of the whole editor to convert the content to plain text. 14 Link Add a hyperlink. 15 Image Add an image. 16 Add Model Element Insert an existing model element or create a new one. 17 Template Save as Template...: Save the current documentation content as a template. Manage Template...: Delete the saved template. 18 Print Print the documentation content. 19 Editor pane Enter and start editing the documentation content.

The description of documentation editor

Editing documentation

Saving a template

1. The documentation you typed can be saved as template in the documentation editor. Choose Save as template... from the drop-down menu of Template.
   

   Choose Save as template...

2.  In the Input dialog box, enter the template name and click OK button to confirm.
   

   Enter template name

Reusing a template

1. In the documentation editor, an existing template can be reused. Select a saved template from the drop-down menu of Template.
   

   Select a template

2. As a result, the selected template will be shown on the documentation editor.

Adding model element

1. Click Add Model Element button on the editor's toolbar after decided a place for inserting a model element.
   

   Click Add Model Element button

2. In Select Model dialog box, select an existing model element on the list. If you want to modify the selected model element, you can click Open Specification... button. On the other hand, you can create a new model element by clicking New... button after select a model element on the list.

   Click Open Specification... button

3. Finally, click OK button to confirm.
4. Consequently, the name of inserted model element will be shown on the documentation pane with underline. If you want to preview the inserted model element, you can right click on its name and select Show View... from the pop-up menu. After the Show View dialog box pops out, you can preview it in the Preview window. If you want to view the actual model element on the diagram, you can click Go to View button.

   Click Show View... from the pop-up menu

Printing documentation

1. After clicking the Print button, the Page Setup dialog box will pop out.
   

   Click Print button

2. In Page Setup dialog box, select size and source for paper, check an option under Orientation and enter the inches for the paper margins.
   

   The Page Setup dialog box

3. Click OK button to confirm printing.