3.10.8. Adding descriptions to items in editors
Prev | 3.10. Working with editors: opening, adding/deleting/renaming items, commenting, adding descriptions, extracting and replacing, reverting changes | Next

### 3.10.8. Adding descriptions to items in editors

Descriptions are longer pieces of text that provide information about nodes in your tests. You can add descriptions in the ITE to Test Cases, Test Suites and Test Jobs via the editor for these items. You can add descriptions to the item itself, or to other items used in it.

1. Open the editor containing the item you want to add a description to.

2. Select the item you want to add, and select from the context-sensitive menu:

   Edit description

3. In the dialog that opens, you can enter text in the upper field. The text you enter can use the syntax of various markup languages (e.g. TracWiki, MediaWiki). You can set the language for your Project in the Project properties (Section 3.6.3, “Editing the Project and AUT properties”).

4. In the lower field, you can see the preview of the text as it will appear in the description view. The preview is updated after a short pause in typing.

5. Click "OK" to close the dialog. You will see the description you have entered in the description view. If the description view is not open, you can open it by selecting:

   Window --> Show View--> Description

6. The changes to your descriptions are saved when you save the editor.

7. You can add a description for the original specification of a Test Case or a Test Suite, and also at places where a Test Case or Test Suite has been reused. You can add a new description to overwrite an existing one when you reuse an item.

8. Descriptions are not displayed in test results.