Using the Rich Text Editor

  Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic! Mail us feedback on this topic!  

Contour provides a rich text editor for writing requirement descriptions, use cases, test cases, etc.  By default Contour has the rich text editor turned on.  If you prefer, this can be turned off by editing the description fields in the Item Types tab of the Admin screen.

While the rich text editor is generally an advantage over plain text, you may want to turn it off if using your own reporting engine or want to tightly control the data entered in these fields.

richTextEditorWithDiagramming

Considerations when using the Text Editor

Advantages

Disadvantages

Easily create rich, descriptive documents
Embed images and hyperlinks within descriptions
Use tables for layout
Templates speed data input
Undo / redo capabilities
Spellcheck is available
Reporting can be difficult as each rich text section may have its own styles. Controlling overall look and feel can be difficult.
Tables do not display when reports are exported to PDF or MS Word format.  This capability relies on underlying conversion software and may be available in the future.
Most 3rd party reporting tools cannot display rich text (HTML) properly, thus using the provided custom report designer would be necessary. (Or the rich text editor may be turned off).
Integrations with 3rd party applications may not be able to accept rich text (HTML) data.

Note: The Editor has right-click options for actions such as accessing properties to list and images.  If this menu is not the editor's but the browsers you need to turn off the spell check option with the Editor.

Appendix

Format – Select the format for the text within the rich text editor.

 

 Size – Select the size for the text within the rich text editor.

 

Cut – Remove the selected text and have it entered on your clipboard.

 

Copy – Copy the selected text to your clipboard.

 

Paste – Paste/Paste from plain text/Paste from word allow you to take data from your clipboard and move it into the rich text editor.

 

Print – Print the informaiton inside the rich text field.

 

Document Templates – Access the document templates that are accessable for your project.

 

       Source – Allows for visibility of the underlying source code for the data within the rich text field.

 

Fullscreen Mode – Allows for the rich text field to consume the entire screen.

 

Text Formatting – Various formatting abliities that can be applied to the text within the rich text editor.

 

Text Alignment – Various text alignment abliities that can be applied to the text within the rich text editor.

 

List Functionaliy – Various list functionaity that can be applied to the text within the rich text editor.

 

Undo/Redo Undo and Redo features allow you to easily correct mistakes within the rich text editor.

 

Find/Replace – A feature that lets you find replace a character string with another string wherever it is found within the rich text editor.

 

       Spell Check Spell check is an application program that flags words in the rich text editor that may not be spelled correctly.

 

Link/Unlink Provides the ability to hyperlink or remove a hyperlink from text within the rich text editor.

 

Add/Edit Diagram Allows for creation or editing of a diagram that has been created within the rich text editor.

 

Image Provides the ability to insert images into the rich text editor.

 

Table Provides the ability to insert a table into the rich text editor.

 

Special Character Provides the ability to insert a special characer into the rich text editor.