Advanced text formatting

 

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.

You can accentuate text in many TestRail fields to add emphasis or importance to your writing. You can use rich text formatting in TestRail by using three types of text editing features: 

 

Before 7.7, only Markdown was available as a text format. If your TestRail instance has been upgraded from a previous version and you want a new editing experience, you can change the setting at project level so that the selected formatting experience is only applied for that project. However, you can also apply this setting globally for your entire instance.

 

The default setting for which editor is applied to your text fields throughout TestRail can be found in the Administration console, under the Site Settings tab. It’s set to Markdown by default, and it’s recommended to leave that setting as it is for instances which have been upgraded from older versions of TestRail, to ensure the integrity of your test cases is preserved.

 

Text Format Selection

 

The text format can be set globally by accessing Administration > Site Settings > User Interface > Text Format and choosing one of the three text formats on the drop-down menu. The text format can be set at project level by accessing Dashboard > Project > Edit > Text Format and choosing one of the formats on the drop-down menu.

image20.png

 

 

Once a text format is selected and saved in a project you will not be able to switch to another text format.

 

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.

 

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.


image15.png

List for Markdown syntax elements in TestRail:



 

Italics and bolds

There are multiple ways to emphasize words using *asterisks* or _underscores_:

  • A single *asterisk* or _underscore_ will _italicize the text_
  • Two **asterisks** or __underscores__ will __bold the text__
  • Three ***asterisks*** or ___underscores___ will ___make the text bolded AND italicized___

 

Input

 

*This is italicized*, and so is _this_.

**This is bold**, and so is __this__.

You can use ***italics and bold together*** if you ___have to___.

 

Output

image14.png

Code and preformatted text

To make a code block, indent four spaces:

 

Input

 

The text below should have code formatting    

    Hello there!

    This code is in a formatted code block

 

Output

image11.png

The text will be wrapped in tags and displayed in a monospaced typeface. The first four spaces will be stripped off, but all other whitespace will be preserved.

You cannot use Markdown or HTML within a code block, which makes them a convenient way to show samples of Markdown or HTML syntax:

image19.png

If code blocks are embedded in text blocks, they require an empty line before and after.



Code spans

Use backticks to create an inline <code> span:

 

Input

 

Press the ` <Tab>` key, then type a ` $` .

 

Output

image12.png

(The backtick key is in the upper left corner of most keyboards.)

Like code blocks, code spans will be displayed in a monospaced typeface. Markdown and HTML will not work within them. 

Note that, unlike code blocks, code spans require you to manually escape any HTML within!

 

Links

 

There are two ways to write links. The second one is easier to read than the first:

 

Input

 

Here’s an inline link to [Google](https://www.google.com/).

Here’s a reference-style link to [Google][1].

[1]: https://www.google.com/

 

Output

image9.png

The link definitions can appear anywhere in the document — before or after the place where you use them.



Headers

 

You can underline text to make the two top-level headers:

 

Input

 

Header 1

=======

Header 2

———–

 

Output

image16.png

The number of = or – signs does not matter. You can get away with just one. But using enough to underline the text makes your titles look better in plain text.

You can also use hash marks for several levels of headers:

 

Input

 

# Header 1 #

## Header 2 ##

### Header 3 ###

 

Output

image5.png

The closing # characters are optional.



Horizontal rules

 

You can insert a horizontal rule <hr/> by putting three or more hyphens, asterisks, or underscores on a line by themselves:

 

Input

 

Rule #1

---

Rule #2

*******

Rule #3

___

 

Output

image22.png

You can also use spaces between the characters:

 

Rule #4   

- - - -

 

All of these examples produce the same output.



Simple lists

 

A bulleted list:

 

Input

 

– Use a minus sign for a bullet

+ Or a plus sign

* Or an asterisk

 

Output

image6.png

A numbered list:

 

Input

 

  1. Numbered lists are easy
  2. Markdown keeps track of the numbers for you
  3. So this will be item 3.

 

Output


image10.png

A double-spaced list:

 

Input

 

– This list gets wrapped in <p> tags

  

– So there will be extra space between items

 

Output

image8.png


Blockquotes

 

Blockquotes are indented.

Add a > to the beginning of any line to create a blockquote.

 

Input

 

> The syntax is based on the way email programs

> usually do quotations. You don’t need to hard-wrap

> the paragraphs in your blockquotes, but it looks much nicer if you do.

 

Output

image3.png

Images

 

Images are exactly like links, but they have an exclamation point in front of them:

 

Input

 

![Valid XHTML](https://w3.org/Icons/valid-xhtml10).

 

Output

image7.png

The word in square brackets is the alt text which appears if the browser can’t show the image. Be sure to include meaningful alt text for screen-reading software.

 

 

Images in the Markdown editor cannot be dragged and dropped, they can only be added with the Input described above, or by a simple copy/paste of the image.

 

Tables

 

Tables can be formatted as follows:

 

Input

 

| Syntax | Description |

 

| --- | ---|

 

| Header | Title |

 

| Paragraph | Text | 

| Paragraph | Text |



Output


image1.png

The first line specifies the table’s column name in bold letters. The dimensions are determined by how many elements you add on every row separated by the vertical bar ‘|’, and ending the row with the vertical bar too, just like in the Input example. To separate the column names from the table, use three hyphen ‘-’ for each column in the next row. The content on the rest of the table is added in the same format as in the first line, that way it renders like in the Output example.

 

The table cells themselves support a limited set of rich-text formatting. The following features are supported inside a table cell:




Advanced lists

 

You can put other Markdown blocks in a list. Simply indent four spaces for each nesting level:

 

Input

 

  1. Lists in a list item:

    - Indented four spaces.

        * indented eight spaces.

    - Four spaces again.

  1. Multiple paragraphs in a list items:

    It's best to indent the paragraphs four spaces

    You can get away with three, but it can get

    confusing when you nest other things.

    Stick to four.

  1. Preformatted text in a list item:

 

        Skip a line and indent eight spaces.

        That's four spaces for the list

        and four to trigger the code block.

 

Output


image2.png

Advanced blockquotes

 

You can put other Markdown blocks in a blockquote. To do so, add a > followed by a space:

Paragraph breaks in a blockquote:

 

Input

 

> The `>` on the blank lines is required

> to create a single blockquote.

>  

> If you leave out the extra `>`

> you will end up with

> two distinct blockquotes.

 

Output


image17.png



WYSIWYG

 

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 add different effects and formatting to your text fields, giving you many options on how you would like your text to look. You can access all of these options in the text format menu located in the top-left corner of each text field.

image4.png 

 

Text Formatting

Click the Text Formatting button image24.png to expand the following selectable options:

  • Bold: turns your text into bold letters
  • Italic: turns your text into italic letters
  • Heading Format: lets you choose between using different sizes of headings (from H1 to H5) or using regular sized text
  • Font Family: lets you choose between different font styles for your text
  • Font Size: lets you choose the font size of your text
  • Font Color: lets you choose the font color of your text and also lets you enter a HEX value to select a color 
  • Background Color: lets you choose the background color of your editor and also lets you enter a HEX value to determine the color that way
  • Insert Link: lets you insert a link in your text by entering the desired URL to be linked and the Text that you want the link to read as. You can also select the option to Open the link in a new tab.

 

Paragraph Formatting

Click the Paragraph Formatting button image13.png to expand the alignment options for your text paragraphs. You can select between Align Left, Align Justify, Align Center, and Align Right to align your paragraphs accordingly.

You can also select List buttons that can add different types of ordered lists as new paragraphs. You can select between Unordered List to add bullet points and make a list, and Ordered List to add a numbered list starting from number 1.

 

Emojis

You can add any type of standard Emojis image18.png from this editor’s library. They are separated into different categories, so make sure you check each one for the desired addition to your text.

 

Add Attachment

Click Add Attachment image21.png to drop image files into the small pop up box, or click + Select Files to choose the specific file you want to attach to the text, from your computer. For now, there is a maximum image file size of 256 MB for each TestRail instance.

 

By clicking this option, you can also select from the Library. This Media Library is a collection of older image files you attached in the past for other text spaces, that also has the option to +Add New files at that moment as well. Select the file(s) you want to add to the text and click Attach. Any file you attach will be added to the Media Library, even if you did not add it to the Library first.

 

To organize this library how you want, you can click on the window’s upper right corner to Sort the files by Date, Name, or Size, and to Filter the library files with an array of options: by Type, Upload Date, Created by, Case, Run, Plan or Milestone each file was used in.There is also a search bar where you can enter a file’s specific name and get to it faster.

 

Once you attach your image file, you can easily manage it by resizing it however you want, and clicking the image will expand 4 more configuration options:

 

  • Display: Lets you choose how to display the image: Inline to allow the image to be aligned with a sentence or paragraph, or Break Text to allow the image to be separated from any text in its own space between lines
  • Align: Lets you align the image Left, Right, or Center
  • Information: Shows you the image information when you uploaded it.
  • Remove: deletes the image from the text (to remove the image completely, access the Media Library, select it and Delete.)

 

Add Table

Click Add Table image23.png to expand the option, and move your cursor to highlight the desired dimensions you want your added table to have (min. 1x1, max. 10x10), and click on the highlighted part to add it. 

Once the table is added, you can click on each cell of the table to display different configurations, and you can hover over them to read which option it is. Click on one of them to apply the corresponding configuration:

 

  • Table Header: Adds a different color header to your table.
  • Remove Table: Removes the added table.
  • Row: Lets you add table rows above / below the current row you click, or remove the row.
  • Column: Lets you add table columns before / after the current column you click, or remove the column.
  • Table Style: Lets you choose between having dashed borders for the table, and having alternate rows by coloring every other row with another color.
  • Cell: Lets you split the cell you click either vertically or horizontally, and also lets you merge cells if you select 2 or more cells.
  • Cell Background: Colors the background of the cell to whatever color you want.
  • Vertical Align: Aligns the text in the selected cell to top, middle, or bottom.
  • Horizontal Align: Aligns the text in the selected cell to Left, Center, Right, or Justified.
  • Cell Style: Lets you choose between having highlighted or thick borders for each selected cell.

 

Plaintext

The Plaintext format is the third text format option you can select. This format has no additional options, syntax, or buttons for your fields, since it only represents readable characters and not other graphical or object representations. 

You can use this standard format as you would with any .txt program. The use of the Plaintext format may be useful to you and your team if you need to preserve content for use in external tools or test automation.  

 

Was this article helpful?
0 out of 0 found this helpful