Documentation pane

Documentation pane enables you to document project data such as model elements, shapes or diagrams either in written or verbal form. For written content, it can be a plain text or HTML text with formattings like bold, italic, table, etc.

The Documentation pane

The toolbar

Name Icon Description HTML It enables you to read and edit 3 different types of content. The 3 types of content include HTML, HTML Source and Plain Text. HTML: Read and edit the original content. HTML Source: Read and edit the HTML source of content. Plain Text: Read and edit content without formats. Bold Set the highlighted text to bold. Italic Set the highlighted text to italic. Underline Underline the highlighted text. Left Justify Set the alignment of highlighted text to left. Center Justify Set the alignment of highlighted text to center. Right Justify Set the alignment of highlighted text to right. Ordered list Add a numbered list. Un-ordered list Add a list with bullet points. Font Select the font family of highlighted text. Font size Select the size of highlighted text. Font color Select the color of highlighted text. Table Add a table. A few formats of insertion for rows and columns can be selected, including: Insert Row Above, Insert Row Below, Insert Column on Left and Insert Column on Right. Insert Row Above: Insert a row above the row you selected. Insert Row Below: Insert a row below the row you selected. Insert Column on Left: Insert a column on the left of the column you selected. Insert Column on Right: Insert a column on the right of the column you selected. Background color Select the background color of highlighted text. Clear formats Clear formats of whole editor to convert the content to plain text. Link Add a hyperlink in a specific place of documentation pane. Image Add an image in a specific place of documentation pane. Add Model Element   Add a model element in a specific place of documentation pane. Save as template... Save the documentation as template. Manage Template... Preview a saved template. Print Print the custom content.

The description of icons on Documentation pane

Closing and opening the Documentation pane

Documentation pane is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View > Panes > Documentation from the main menu.

Documenting project data in text

Documentation pane enables users to type in the textual description for project data, for instance, model elements, shapes and diagrams.

Defining a glossary item

A word or a lexis can be defined as a glossary item for explication.

1. Highlight the word or the lexis you would like to be defined and then right click on it. Select Add "[term]" to Glossary from the pop-up menu to switch to Glossary Grid.
   

   Select Add "premium" to Glossary from the pop-up menu

2. In Glossary Grid, select the term and then click Open Term Editor button in order to fill more details about the new item. Alternatively, right click on the term and select Open Term Editor from the pop-up menu. 

   Open term editor

3. In Term Editor page, click Add button to type the alias(es) for the new item.
   

   Type an alias for the term

4. Further information about the new term can be given by typing in the space under Definition.
   

   Enter term definition

5. Finally, click OK to confirm editing. The window will then return to Glossary Grid.
6. Moreover, you can insert as many new terms as you prefer. In Glossary Grid, click  to create another new term.

Checking the spelling

When you type an incorrect word carelessly, documentation pane can offer you a help.

For correction, right click on the incorrect word with a red curved line and select a suggested word from the pop-up menu.

Select a correct word from the pop-up menu

Moreover, you can add a new word to the dictionary if the word you typed is a rare word or a new created word. Right click the new word and select Add to dictionary from the pop-up menu. When you type the word next time, it won't be marked as an incorrect word again.

Documenting a shape by voice

In addition to textual description, documentation pane also enables users to document for project data in verbal form.

Click Record... button for recording voice.

Click Record... button

In Record Voice dialog box, enter the name for the audio clip. Click Record to start recording while click Stop button to terminate. Click OK if you want to save the voice recording; click Cancel, and vice verse.

Click Record button in Record Voice dialog box

Name Icon Description Record   Press it to start recording. Play Press it to play the voice you recorded. Stop   Press it to stop recording. Clear   Press it to clear the voice you recorded.

The description of icons on Record Voice dialog box