Manual test syntax

Use markdown for adding steps and for formatting text.

Test syntax

When working in the Text Editor, use the following syntax to add steps:

Setup or regular steps

Each step starts with a hyphen and a space.

Example: - Navigate to the Web site.

Validation steps

Each step begins with a hyphen, space, and question mark:

Example: - ? Validate that the page loaded correctly.

Call to step

Each step begins with a hyphen, space, and the @ character with the ID number of the test to call:

Example: - @1102 Search by user

Parameter

Syntax: <parameter name>

Example: Use port number <port>

For details, see Use parameters in tests.

A step can span more than one line. You do not need put a hyphen and space on other lines if a step continues.

Tip: When working in the text editor, a red X displays next to any lines with syntax or logic errors. For example, a call step cannot call the its own test.

Back to top

Format text in the test script

Use markdown in your test script to emphasize text and display it in bold, italics, underline, or colors (red, green, blue).

Aside from the text editor, all other displays of the test script will include the formatted text (for example, the Visual Editor, Manual Runner, and Run report).

To format text:

In the Text Editor, use the following syntax to format your test script:

Bold **text**
Italics *text*
Underline __text__
Red {text}red
Green {text}green
Blue {text}blue

For example:

- Display the following in bold: **bold**
- Display the following in italics: *italics*
- Display the following underlined: __underline__
- Display the following in red: {red}red
- Display the following in green: {green}green
- Display the following in blue: {blue}blue

The Visual Editor will display the formatted test script:

Note: You can combine formatting. For example: *You can **combine** formatting*

Back to top