Topics Map > Documents Tab

KB User's Guide - Documents Tab - How to Create Anchor Tags and Links

If you need to link to a specific section within a document, you can do so by using an anchor and a link that points to that anchor. This document contains step-by-step instructions on how to add anchor tags and links to your documents.

Start by going into KB Admin Tools and opening the Documents tab. Either create a new document or edit an existing document. Perform the following steps in the Body field of the document editor:

Creating a new anchor

  1. Enter the text that will serve as the anchor and highlight it. Usually this is the heading for your section. Open the Insert menu and select Anchor....

    The "Anchor..." option is the fourth item under the Insert menu
  2. Enter the ID for your anchor. This should usually relate to the text it relates to. For example, if you were creating an anchor for the section titled, "Support Information," an appropriate ID might be "support-info" or "support".

    Example of an anchor ID, where "support dash info" was entered for the ID

    Please note the following:

    • IDs cannot contain spaces. If you would like to separate multiple words, we recommend using hyphens/dashes.

    • Uppercase letters are allowed, however, please note that URLs in the KB are case sensitive. If you capitalize words, they will need to be capitalized the same way when the link is used elsewhere.

    • Numbers can be used, though the first character of the ID must be a letter.

    • Dots, colons, and underscores may also be sued, though we do not generally recommend using them.

  3. Click Save. The text you selected in step 1 should now be preceded by an bookmark icon. This means your anchor was successfully inserted.

    Example of a heading titled, "Support Information" where the heading is preceded by a bookmark icon indicating the heading has an anchor

Linking to an anchor in the same KB document

  1. If you have already entered the text you would like to use for your link, highlight it. You may also simply place your cursor where you would like to add the link.
  2. Select the Link button in the toolbar or under the Insert menu.

    Screenshot showing the Link button in the editor toolbar, which is represented by a chain link icon

  3. If you had highlighted text when you clicked the Link button, this text will be pre-populated in the Text to display field. If not, enter your desired display text here. Then, open the Anchors dropdown menu and select the anchor ID you would like to link to. This will populate the URL field.

    Alternatively, you may manually populate this field by entering a hash (#) character followed by the ID.

    Screenshot of the "Insert/edit link" window, where the text to display is "Learn more about support", and the "support dash info" anchor has been selected in the dropdown. This has caused the URL field to be populated with the text "hash support dash info".

  4. Click Save to insert your link.

Link to an anchor in another KB document

To point to an anchor on a different KB document, you need to add a little more text in the target URL of the link field, so the browser knows that some of the current URL will also change.

  1. If you have already entered the text you would like to use for your link, highlight it. You may also simply place your cursor where you would like to add the link.
  2. Select the Link button in the toolbar or under the Insert menu.

    Screenshot showing the Link button in the editor toolbar, which is represented by a chain link icon

  3. If you had highlighted text when you clicked the Link button, this text will be pre-populated in the Text to display field. If not, enter your desired display text here.

  4. In the URL field, enter the absolute or relative URL of the document you would like to link to. If you aren't sure which to use, enter the full URL of the document.

    At the end of the URL, enter a hash (#) character followed by the anchor ID in the other document you would like to link to.

    Screenshot of the "Insert/edit link" window, where the text to display is "Learn more about support", and the URL is set as "slash kb guide slash 12345 hash support dash info"

  5. Click Save to insert your link.



Keywordsadd anchors tag link to section link within a page link points to anchor a href tag point hashtag syntax automatic anchors   Doc ID18575
OwnerLeah S.GroupKB User's Guide
Created2011-05-16 18:00:00Updated2024-02-14 14:47:40
SitesKB Demo, KB Demo - Child Demo KB, KB User's Guide
Feedback  0   0