ServiceNow Knowledge: Create a Link in an Article
There are two parts to adding a link to a KB article -- the text that contains the link, and the link itself.
This article covers creating external links. You can also Create Internal Links in an Article for use in a table of contents such as the one below.
In this article:
- Link text standards
- Creating a link in an article
- Provide some information when read out of context.
- Explain what the link offers OR provide the title (or close to it) of the target page.
- Be at the end of a sentence or as close to the end as possible.
- It’s OK to put a link within a sentence as long as no critical information follows.
- If possible, avoid phrases like For more information see.
- Not be the hyperlink itself unless it’s not possible to provide a link associated with descriptive text.
If the link leads to a file download, be sure to include that information so the user is not surprised. For example,
- Download Malwarebytes
- Quick Guide (PDF)
- Always use the ServiceNow permalink for both internal and public articles.
- Set the link to open in a new window. All external links should always open in a new window.
- Note: Links copied into an article from elsewhere, such as a Google doc, will need to be updated to open in a new window.
- Don’t include the KB article number in the text.
- Leave out the application name in the text (except when needed for clarification). For example:
Actual article title: ServiceNow: Insert or Edit an Image in an Article
Article title when referenced in an article: Insert or Edit an Image in an Article
- View the article in ServiceNow View mode.
- Scroll all the way to the bottom of the window.
- Click Copy Permalink. The permalink address is copied to your clipboard.
- Select the text to link.
- Click the Insert/Edit link icon on the Editing Toolbar.
- Paste the complete link in the URL box (including http:// or https://)
- Choose Target: New window (_blank).
- Click OK.