Hyperlinks

Table of Contents

Terminology

Use hyperlink or link to describe text or a graphic that readers can select to go to another document, to another place within the same document, or to a webpage. Use hyperlink to refer to a UI element labeled hyperlink.

Note: This guide discusses style considerations. For information on creating and editing links, see the WordPress guide.

Links in content

End of sentence

When a link ends a sentence, don’t include the closing punctuation in the hyperlink. However, if you’re providing a link to another page and using the page’s title as the link text, and the post name ends in punctuation, include the punctuation in the link. Don’t add additional punctuation to the end of the sentence.

Correct examples

  • For more information, refer to How do I get started?
  • To endorse or make changes to a policy, you must create a revision.
  •  If you commit a revision and the policy status is Submitted, the Confirm dialog box will open instead of the Commit Revision dialog box.

Incorrect examples

Spaces

Never include the spaces before or after linked text as part of the link.

Correct examples

  • To endorse or make changes to a policy, you must create a revision.
  •  If you commit a revision and the policy status is Submitted, the Confirm dialog box will open instead of the Commit Revision dialog box.

Incorrect examples

Tip: When you’re writing, you can select/unselect the link text as you move the insertion point with the left and right arrow keys. The link will highlight/un-highlight to indicate if it’s selected or not. This will make it easier to identify where extra spaces may be attached.

Tabbing

Regarding links to other help site pages, use your best judgement when determining if links should open in a new tab or not. Our goal is always to improve the reader’s experience whenever we can. Sometimes, it’s necessary or desired to have multiple tabs open to learn about a subject area. Other times, it may not be a concern.

When linking to external sites or resources, links should always open in a new tab.

Titling conventions

The following methods are both acceptable, but try not to mix them within the same page/post. Use your instincts as to what will optimize the reader’s experience.

Title-based

When referring and linking to another page/post by title, link only the title text and make sure the same casing is used for both (sentence case).

Correct example

For more information, refer to Retrieve product definition to get product definition endpoints and details. The link matches the title.

Incorrect example

For more information, refer to Retrieve product definition to get product definition endpoints and detailsThe way this is written and linked implies the full link text is the title of the linked page.

Subject-based

You’re not required to link by title; you can also incorporate the subject into the sentence.

Examples

For more information, refer to the tutorial on retrieving product definitions to get product definition endpoints and details.

You can customize your preferred username/alias in BriteAuth. When you choose a preferred username, you can log in with either your original username as set up by an administrator upon invitation or your preferred username.

Note: The subject-based method is more subjective in what you link as it depends on what you write. Don’t make the link too long and focus on linking the action or command in question.

Table of Contents