Links in TDX knowledge base articles

A link should make sense when read on its own, out of the context. This way, assistive technology can provide a list of links on the page, and users can choose from the list.

"Click here" or "More information" as link text is NOT ADA compliant. This text does not describe the link's destination.

Links should also follow the knowledge base standards:

  • External links should open in a new window/tab.
  • Bold links that are within a sentence.

The minimum requirement for Level A is that the purpose of each link can be determined from the link text itself or from the link text within the context of the surrounding text, but for Level AAA, the purpose of each link must be able to be identified from the link text alone.

To ensure web accessibility, see W3C's pages on:

Create or edit a link in a knowledge base article or service description

screenshot showing the TDX editor buttons with Link button on second row, fifth from the right

Create a link in an article or service description by selecting the link text and clicking the Link button. Copy the URL of the link target, paste into the URL field, and click OK.

To find the URL of a knowledge base article to link to, open the article in a browser, and copy the link.

To have the link open in a new window or tab, select the Target tab when creating a link, click the Target dropdown, and select New Window (_blank).

To edit an existing link, right-click in the linked text, and click Edit Link.

Links that are set in Microsoft Word will carry over when copied and pasted using the Paste from Word button.

Using named anchors to link within the article

screenshot showing the TDX editor buttons with Anchor button on second row, third from the right

Named anchors are markers that can be placed within an article to link to that specific section.

To place named anchors in the article, click to place the cursor in the text where the anchor will be located. Click the Anchor button. Type a name in the Anchor Name field.

To create a named anchor link, select the link text, click the Link button, and from the Link Type dropdown, select Link to anchor in the text. From the By anchor name dropdown, select an anchor from the list of anchors that were previously placed in the article.

To link to a named anchor from a different article, open the article in a browser, click on the anchor link, and use that URL for the link.