Simple ways to include links to User Stories etc

Simple ways to include links to User Stories, Feature Specs, Issues and more

Simple ways to include links to User Stories etc

All about the several simple and flexible methods that Testpad has for including links to third-party content.


By Stef

March 3, 2019

Linkedin Logo Twitter Logo Facebook Logo

est plans don't exist in isolation. They very often come from, or at least need to be associated with, the specs or user scenarios or plain-old requirements that were used in the creation of the product you're testing.

It's also common to want to provide the tester with additional resources in the form of links to help documentation, or other further context on the where/why/what of the topics under test.

Simple clickable links

As usual, Testpad doesn't try to be complicated with making such connections to third-party material. Instead offering a variety of methods for including clickable links that simply load up the referenced page in a new tab... basically what the hypertext in http means!

To include links in your tests, choose from:

typed in asdisplayed as
Plain linkshttps://testpad.com"https://testpad.com"
Markdown-style links[TestpadHQ](https://ontestpad.com)"Testpad"
Wiki-style links`[[https://ontestpad.comTestpad]]`
ShortcodesUS:123"User Story 123", linking to https://my.requirements.com/story/123

NB don't forget to enable links in Project Settings

Include links wherever they're helpful

Testpad lets you include links in most places that accept text input:

  • Test text titles


  • Test text comments

    Plain in comments

  • Embedded in test text

    Markdown as Test

  • the Notes field behind every test

    Wiki in notes dialog

  • Script Description blocks

    Shortcodes in desc

  • Note Items in Folders that sit beside links to Scripts

    Plain in note Items

  • Comments against individual results

    Plain in results

Plain Links

Whenever you include an obvious link (starting http:// or https://) in some text, Testpad will recognise it as a link and display it as a clickable link opening in a new tab. If the link isn't too long or complicated looking, this method is basically just for free and happens without even reading up on the details!

Markdown-style Links

If you go to Project Settings for your project, you can enable Markdown-style Links (they're off by default), which means any time you include a link with the pattern [Title](link), the "link" will be displayed as the clickable "Title". Useful for longer/complex URLs that otherwise confuse the text they're appearing in.

Wiki-style Links

Similarly, in Project Settings, you can alternatively enable Wiki-style Links, so that any time you include a link with the pattern [[ link | Title ]], the "link" will be displayed as the clickable "Title".

Short-codes for common link patterns

Lastly, and perhaps most powerfully, Testpad includes a link pattern generator which is great for when you want to include lots of links to very similar URLs. For example, if every test block needs to link to the User Story item in JIRA that it pertains to, it would be tedious to include the full JIRA path in every test title.

The Project Settings page lets you define short-codes that map a prefix:code pattern onto a link pattern. This is probably best explained by example:

The definition:

Shortcode Definition

is defining a short-code "story", such that whenever some text includes "story:ABC123" (i.e. "story" followed by a colon followed by some characters), the short-code will be replaced with a link to "https://some.website/issue/ABC123" that's displayed as User Story ABC123.

Green square with white check

If you liked this article, consider sharing

Linkedin Logo Twitter Logo Facebook Logo

Subscribe to receive pragmatic strategies and starter templates straight to your inbox

no spams. unsubscribe anytime.