Use the rich text editor

  Work in Jama > Work in projects > Create and manage items > Edit items >

Use the rich text editor

Previous pageNext page Print this topic! Mail us feedback on this topic!

Jama provides a rich text editor for writing requirement descriptions, use cases, test cases, etc. This text box is similar to other text boxes, but it will also store formatting and other rich text items such as images and tables.

Tips

To start a new paragraph, hit enter.
To add formatting, select the desired text and select the appropriate button at the top of the rich text editor.

RTEFormatting

Images can be inserted, can be resized by grabbing and dragging the bottom right-hand corner handle, and can be moved by grabbing the handle on the top left-hand corner. Double-clicking on the image will display the image property window, which can be edited.
Tables can be formatted by selecting any cell, then selecting the Table Edit button:

RTETableMenu

 

Cell and Row specific options, such as Insert Cell Before and Insert Row Before are available by expanding the appropriate menu option:

RTETableMenu2

Tables can be resized by selecting the table borders.

 

 

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.

Note: Whenever a rich text item is saved, Jama will delete certain text (usually code such as javascript) that could be a security risk. This will not affect the vast majority of data entered into Jama.

richTextEditorWithDiagramming

Note: Jama recommends creating tables manually in Jama instead of importing them from other documents. Once a table has been imported, it becomes very difficult to work with and will not export cleanly.

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.
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.

 

Rich Text Editor Buttons

RTEFormat

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

 

RTESize

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

 

RTECutPaste

 

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

Copy: Copy the selected text to your clipboard.

Paste: Pastes data from your clipboard and move it into the rich text editor.

Paste as Plain Text: Pastes the selected text without rich text formatting.

Paste from Word: Pastes the selected text from Word with all Word (rich text) formatting.

 

RTESource

 

Document Templates: Access the document templates that are accessible for your project. See Using Templates for more details.

Source: Allows for visibility of the underlying source code (including HTML formatting) for the data within the rich text field. You can add div HTML elements in order to apply custom styling. Note that not all custom styling may be supported throughout Jama, such as inside reports; verify that your custom styling works as expected.

 

Fullscreen Mode: Maximizes the field.

 

RTETextFormatting

 

Text Formatting: Various formatting properties that can be applied to text within the rich text editor.

Clear Formatting: This button will remove any formatting in the selected text.

RTESubscript

Subscript: Any text highlighted when this button is selected will become a subscript.

Superscript: Any text highlighted when this button is selected will become a superscript.

 

 

RTETextAlignment

 

Text Alignment: Various text alignment properties that can be applied to text within the rich text editor.

 

RTELists

 

List Functionality: Various list properties that can be applied to the text within the rich text editor.

 

rteundohosted

 

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

Find: Find text within the rich text editor.

Replace: Replace highlighted text with new text.

 

RTELink

 

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

 

RTEAddFunctions

 

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

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

Add Image from Server: Allows an image to be uploaded from a file path.

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

Special Character: Allows special characters to be inserted into the rich text editor.

 

Note: Viewing source allows for visibility of the underlying source code (including HTML formatting) for the data within the rich text field. You can add div HTML elements in order to apply custom styling. Note that not all custom styling may be supported throughout Jama, such as inside reports; verify that your custom styling works as expected.