Editing Description or other Rich Text Fields

Overview

Editors of various record types such as Use Cases, User Stories, Requirements, etc., contain Rich Text Fields such as Description, Acceptance Criteria, etc.

Rich Text Fields allows you to format text and insert tables, images, links, etc.

This article covers the following topics.

Rich Text Toolbar UI
Formatting Text
Formatting Paragraph
Inserting Tables
Inserting Screenshot
Inserting Images
Inserting Special Characters
Inserting Mathematical Equations
Inserting Horizontal Lines
Inserting Links to Repository Artifacts/Issues
Inserting Diagrams
Keyboard Shortcuts

Toolbar UI

Formatting Text

Select text and apply any of the following formatting options. You can also place the caret at a location, select some formatting options, and start typing. The text will have the specified formatting until you change it. You can also use keyboard shortcuts.

Formatting Option	Description	Keyboard Shortcut
Bold	Bold text	Ctrl+B
Italic	Italic text	Ctrl+I
Underline	Underline text	Ctrl+U
Font Family	This is available when rich text field is opened in Full Screen or under More Text menu.
Font Size	This is available when rich text field is opened in Full Screen or under More Text menu.
Text Color	This is available when rich text field is opened in Full Screen or under More Text menu.
Background Color	This is available when rich text field is opened in Full Screen or under More Text option.
Strikethrough	Strikethrough text. Available in More Text menu. $C:\Users\TECHNO~1\AppData\Local\Temp\SNAGHTML8221c5.PNG$
Subscript	Selected text becomes subscript. Available in More Text menu. $C:\Users\TECHNO~1\AppData\Local\Temp\SNAGHTML832dc6.PNG$
Superscript	Selected text becomes superscript. Available in More Text menu. $C:\Users\TECHNO~1\AppData\Local\Temp\SNAGHTML83feab.PNG$
Clear Formatting	Remove formatting from the selected text. Available in More Text menu. $C:\Users\TECHNO~1\AppData\Local\Temp\SNAGHTML847f20.PNG$

Select text to perform the following actions in the pop-up menu:

Pop-up Menu Option	Description	Help
Add As	The Add as feature will assist you to create an artifact (requirement, repository artifact, or issue) from the selected text and also insert a link in the rich text field of the created artifact.	Click here
Add to Glossary	Add selected text to the Glossary.
Add link	Select a text in a rich text field and link it to an existing repository artifact or issue. You can add hyperlinks to the selected text using the Insert Hyperlink action.	Click here

Formatting Paragraph

You can apply header styles, add bullets and numbers, align text in a paragraph, etc.

Formatting Option	Description	Keyboard Shortcut
Paragraph Format	Apply styles to text. Available in Full Screen.
List formatting	Create an ordered list or an unordered list. Select a look to apply to the list. Ordered List looks: Unordered List looks:
Align Text	Available in More Paragraph menu. Change text indentation to: Decrease Indent Increase Indent Align text to: Left Center Right Justified Select how much spacing appears between lines of text or paragraphs (available in full screen mode).	Ctrl+[ Ctrl+]

Inserting Tables

To insert a table, click the button on the toolbar and drag the mouse over the grid until you highlight the number of rows and columns you want to insert.

Once the table is inserted, you will get all other table editing commands by clicking any table cell.

Table Commands	Description	Keyboard Shortcut
Table Header	Insert Table Header.
Remove Table	Deletes an entire table.
Row	Insert a row above, below, and delete selected rows.	Insert a new row by pressing Tab when you reach the end of the row. Also, pressing Tab moves to the next cell. Move to the previous cell using Shift+Tab.
Column	Insert a column to the left, right, and delete selected columns.
Table Style	Apply special formatting to borders using the style Dashed Borders or alternate rows using the style Alternate Rows.
Cell Operation	You can: Merge selected cells into one. Perform splitting selected cells into vertical or horizontal.
Cell Background	Apply background color to a cell.
Text Alignment	You can align text in a cell: Vertically Horizontally: Left, Center, Right, and Justified
Cell Border Color	Apply border color to a cell:

After inserting a table, click inside any cell to enter text. All text formatting options are available for text in table cells.
You can also insert images in cells in the same way as explained in the Insert Images topic.
Table inserted automatically resizes itself in the field. You can resize columns by dragging borders.

Inserting Screenshot

You can directly insert a screenshot by capturing the desired region of the tab, window, or entire screen.

You can capture the screen from the browser’s share screen. After you select the region, the selected screen gets captured and opened in Image Editor.

$C:\Users\TECHNO~1\AppData\Local\Temp\SNAGHTML150bdc9.PNG$

You can edit and insert the captured screen in the Rich Text editor at the cursor position.

Inserting Images

You can add images to a rich text field using one of these methods.

Drag-and-drop Image

You can drag an image from your desktop and drop it into a rich text field.

Browsing Image

Browse an image in folders and select it to insert into a rich text field by clicking the Insert Image button on the toolbar, as shown in Fig. 1. above.

Using Copy & Paste

Copy an image from TopTeam or external sources, place your cursor in a rich text field, and paste it using Ctrl+V.

Once the image is inserted into the editor, you can resize it by selecting and dragging the bottom right corner handle.

Image Editing Options

Image Editing Option	Description
Open Link	Open the link in another window. For example, For a wiki artifact, the link will open the wiki editor. For an artifact in baseline mode, the link will open in baseline mode. For How Do I action link, the link will not open in edit mode.
Replace Image	Insert another image at the place of the current image.
Align	Align images left, center, and right.
Image Caption	Enter image caption.
Remove	Delete image.
Insert Link	Insert URL to use an image as a link.
Display	Specify to add an image inline with text or a new line.
Style	Apply the following styles to an image.
Alternative Text	Add text you want to display instead of an image when it fails to load/display.
Change Size	Specify the width and height of an image.

Inserting Special Characters

You can insert special characters into a rich text field, as shown below.

Inserting Mathematical Equations

You can insert Mathematical Equations into a rich text field such as:

To learn more about inserting mathematical equations, click here.

Inserting Horizontal Lines

If you want to insert a horizontal line in between your text, you can add it using the following action on the toolbar. This option is available in Full Screen mode.

Inserting Links to TopTeam Repository Artifacts/ Issues

You can insert links to existing artifacts/issues using the following options.

Method	Description	Help
Using Quick Explorer	Select artifacts in Quick Explorer (a floating screen that displays repository artifacts) and insert them into a rich text field of an artifact.	By selecting artifacts in Quick Explorer and using copy-paste method By selecting artifacts in Quick Explorer and using drag-and-drop method
Insert Record Link	Traceability link is created when you insert an artifact or issue into a rich text field.	How to create traceability by inserting Artifacts & Issues Link in Rich Text Fields
Insert TopTeam Diagram	Insert a diagram of a record type such as Business Process, Mind Map, Wireframe, etc.	See Inserting Diagrams topic.
Insert Hyperlink	Select a text and add a hyperlink to that text in the same way as you add using the Insert Hyperlinks action.	Enter Address (URL), Display Text, and Hint (optional), and click OK to hyperlink the selected text.
Add AsSelect a text from a rich text field or comment and add as artifacts using Add As feature. How to add artifacts using Add As featureUpdate Link Text	You can edit the text in the link by using the Update Link Text action.
Refresh TopTeam Diagram	You can refresh to update all diagrams and hint text.

NOTE

A trace link is created only when a traceability rule is defined between the inserted record type and the record type into which you are inserting. To learn more, click here.

Inserting Diagrams

You can add a TopTeam diagram of any record type into a rich text field.

Place the caret at the position where you want to insert a diagram and select the Insert TopTeam Diagram button on the toolbar.

Select a diagram record type and the diagrams that you want to insert.

Diagram inserts into the rich text field as an image. Once inserted, you can edit the image using Image Editing Options.

You can resize it by selecting and dragging the bottom right corner handle.

Keyboard Shortcuts

Use the following keyboard shortcuts in rich text fields.

Common Actions	Keyboard Shortcut
Copy	Ctrl+C
Cut	Ctrl+X
Paste	Ctrl+V
Undo	Ctrl+Z
Redo	Ctrl+Shift+Z
Insert Link	Ctrl+K
Insert Image	Ctrl+P
Basic Formatting
Select All	Ctrl+A
Bold	Ctrl+B
Italic	Ctrl+I
Underline	Ctrl+U
Increase Indent	Ctrl+]
Decrease Indent	Ctrl+[
Quote
Increase quote level	Ctrl+’
Decrease quote level	Ctrl+Shift+’
Image/Video
Resize larger	Ctrl++
Resize smaller	Ctrl+-
Table
Select table cell	Alt+Space
Extend selection one cell	Shift+Left/Right arrow
Extend selection one row	Shift+Up/Down arrow
Navigation
Shortcuts	Ctrl+/
Focus popup/toolbar	Alt+F10
Return focus to previous position	Esc

How to add artifacts using Add As feature

Revised: September 22^nd, 2023