This functionality is currently available for users on the Early Access release track. See Quarterly release tracks for more information about how to update your instance to the early access track.
As of TestRail 9.7, the introduction of the WYSIWYG text editor in your TestRail environment will affect multiple areas where text input and editing are required. WYSIWYG (What You See Is What You Get) is a format that allows content to be edited in a form that will be rendered or displayed in the same appearance as you are editing it.
You can accentuate text in many TestRail fields to add emphasis or importance to your writing, as well as add formatting, links, or even media to make your text appealing and modern-looking.
Rich Text Editor
This editor is enabled for most of your instance's important text fields by default. Once you click on each field space, your editor toolbar should appear at once as well as a new Quick Insert button next to the line you clicked on, if your text space is empty.
This toolbar includes many main actions that you can implement to format your text in a variety of ways, according to your every need:
- Bold: write your text with bold letters
- Italic: write your text with italic letters
- Underline: write your text with an underline for each word.
- More Text: explanation below.
- Ordered List: adds a basic numbered list.
- More Paragraph: explanation below.
- Insert Link: write the text you want your URL to link to, with an option to open it in a new tab.
- Insert Image: select an image file to attach from your Media Library, or add a new one from your device.
- More Rich: explanation below.
- Undo: go back to your previous action.
- Redo: go forward to an action you just undid.
- More Miscellaneous: explanation below.
- Markdown: explanation below
Additionally, as you can see in the image above, the buttons More Text, More Paragraph, More rich, and More Miscellaneous expand a sub-menu of additional actions that you can further implement. Just click on each one to expand or click again to close each sub-menu.
When you click More Text, you get the following actions:
- Strikethrough: write your text with a line across.
- Subscript: write smaller text below your normal line of text.
- Superscript: write smaller text above your normal line of text.
- Text color: choose your desired text color.
- Background colour: choose your desired background color.
- Inline Class (Highlighted): choose your inline text class, code or highlighted.
- Clear Formatting: erase any of the applied format to a selected text.
When you click More Paragraph, you get the following actions:
- Ordered List: change your basic list to have upper or lower cases, Greek, Roman, or Default.
- Unordered List: change your basic list to have bullets, circles, squares, or Default.
- Paragraph Format: choose different text size or headings (from H1 to H4), normal size or code.
- Quotes: make your text into a quote or a callout.
When you click More Rich, you get the following actions:
- Insert Table: insert a customized table, ranging from 1x1 to 10x10.
- Emoticons: choose to insert your favorite emoji.
- Special Characters: choose to insert special characters from a wide array.
- Insert Horizontal Line: give your text a separation by inserting a horizontal line.
When you click More Miscellaneous, you get the following actions:
- Code View: view your text's code format.
- Help: access all the shortcuts you need for text format.
Also, as explained previously, you can click the Quick Insert button (the '+' next to each new text line) to open a set of mentioned actions to insert in a prompt manner. Among these quick actions, we have: Insert Image/Video, Insert Table, Insert Horizontal Line, and Ordered/Unordered List.
Markdown
Markdown is an easy to learn syntax that allows you to format words in the rich text editor. For example, to make a word appear italic, just surround it with asterisks like *this*. Likewise, to make a word appear bold, surround it with two **asterisks**.
There are syntax elements to make lists, add links, include code blocks, headers, images, and a lot more. Please see below for a list of syntax options available to you and for examples on how to use them.
Starting with TestRail 9.7 the syntax of Markdown elements were updated to use with the new editor. Existing legacy Markdown syntax will still be correctly displayed and will be converted automatically to the new format when you first edit them.
The Markdown editor has a preview functionality that shows you the rendered text as you write it in Markdown syntax, and also a full screen mode that allows you to write the syntax on the entirety of your window.
The Markdown editor provides a preview of the Markdown syntax typed on the left hand side, however if you wish to save this information (the formatted output or the markdown syntax) this text must be copied to the corresponding TestRail field you are currently working on.
List for Markdown syntax elements in TestRail:
| Element | Markdown Syntax (Code) | Output |
|---|---|---|
| Heading | # H1 ## H2 ### H3 |
|
| Heading ID | ### My Great Heading {#custom-id} | |
| Bold | **bold text** | |
| Italic | *italicized text* | |
| Strikethrough | ~~The world is flat.~~ | |
| Blockquote | > blockquote | |
| Ordered List | 1. First item 2. Second item 3. Third item |
|
| Unordered List | - First item - Second item - Third item |
|
| Code | `code` | |
| Fenced Code Block | ``` { “firstName”: “John”, “lastName”: “Smith”, “age”: 25 } ``` |
|
| Horizontal Rule | --- | |
| Link | [title](<https://www.example.com> "title") | |
| Image |  | |
| Table | | Syntax | Description | | --- | ---| | Header | Title | | Paragraph | Text | |
|
| Footnote | Here’s a sentence with a footnote. [^1] [^1]: This is the footnote. |
|
| Definition List | term : definition |
|
| Task List | - [x] Write the press release - [ ] Update the website - [X] Contact the media |