Adding hyperlinks

Plans supporting the use of hyperlinks

In Document360, you can add hyperlinks to letters, symbols, words, phrases, paragraphs, images, or files in your articles or category pages.

Adding hyperlinks to an article

1. In Markdown editor, click the link () icon at the top of the editor.

   Alternatively, if it Advanced WYSIWYG editor, use the slash command /link, or highlight the desired text and press Ctrl + K, or go to Insert > Link.

   The Insert link panel will appear.

   In the Link text field, enter the text to be hyperlinked.

2. To link to an existing article, start typing the article name in the Search & link to existing article field. The list of articles will appear.

3. To link to a specific heading in the current article, use the Link to the current article heading dropdown to select a heading (H2, H3, H4). The appropriate URL slug will be generated.

4. Alternatively, you can just enter a URL in the Link field for external links.

5. If needed, select the Open in a new tab checkbox.

6. Once done, click Insert.

How do I edit or unlink the hyperlink?

In the Advanced WYSIWYG editor, follow these steps to edit or remove a hyperlink:

1. Click on the hyperlinked text. A floating menu will appear.

2. To manage the hyperlink:

   • Open the link: Click on the link to visit the URL.

   • Edit the link: Click on the Edit () icon to modify the hyperlink.

   • Unlink the text: Click on the Unlink () icon to remove the hyperlink.

   • Copy the link: Click on the Copy () icon to copy the hyperlink.

Bookmark links inside articles/category pages

When dealing with long articles or category pages, bookmark links allow you to link directly to specific headings (H2, H3, H4) within the same article.

1. Click the link () icon in the editor.

2. In the Link to the current article heading field, choose a heading from the dropdown list. This creates a URL slug linking directly to that section.

3. If needed, select Open in new tab.

4. Click Insert.

NOTE

• The H3 and H4 headings will only be available in the dropdown if enabled in settings. To enable them, navigate to Settings () > Knowledge base site > Article settings & SEO > Article settings > Article right and ensure H3 and H4 are selected.

• If you're using the Advanced WYSIWYG editor, you can also press Ctrl+K to quickly add hyperlink to the text.

Adding an Email link to an article

For Markdown editor

1. Select the text you want to link and click the link () icon.

2. In the Link field, use the following Markdown format to create an email link:

   [link_text](mailto:email_id)

For example, if you want to add an email hyperlink to test@gmail.com with the link text "Email support", type:

[Email support](mailto:test@gmail.com).

Outcome: Email support

For Advanced WYSIWYG editor

1. Select the desired text and press Ctrl + K or use the slash command /link.

   The Link panel will appear.

2. In the Link field, type the desired email in this format → (mailto:email_id).

3. Click Insert.

Does an article heading hyperlink work if I change the heading?

No, if you change the heading, the existing hyperlink will break.

For example, if you add a hyperlink to an H3 heading titled "Markdown editor" and later change the heading to "The Markdown editor," the hyperlink will break and no longer work.

How to overcome this scenario?

This method is applicable only in the WYSIWYG editor. When you directly update a heading, both the heading link and name are updated. However, to change the heading without affecting the heading link, you need to update the HTML tag for the heading ID.

Typically, an H2 heading is formatted as <h2>Heading name</h2>. To separate the heading link from the name, you can modify the tag as <h2><a name="heading-link"></a>Heading name</h2>.

For example, you want to update the H2 heading name 'How Risk Analytics Works' to 'Risk Analytics'

• Your current heading tag would be <h2>How Risk Analytics Works</h2>

• Replace it with <h2><a name="How-Risk-Analytics-Works"></a>How Risk Analytics Works</h2>
  Heading link - How-Risk-Analytics-Works
  Heading name - How Risk Analytics Works

• Now change the heading name to Risking analytics, and don't change the heading link
  <h2><a name="How-Risk-Analytics-Works"></a>Risk Analytics</h2>

• If you have added a hyperlink for this heading, it will work fine even after changing the heading name. This is because the heading link is kept the same.

What happens to the hyperlinks when I do a machine translation?

When an article is translated, all internal hyperlinks in the original language are updated to link to the corresponding translated articles in the new/draft state.

For example, an article in English contains internal links to other articles. When translated to French, those links will redirect to the French versions of the linked articles.

NOTE

To avoid broken links in translated articles, ensure that article slugs are consistent across languages.

For example, if the English article has the slug /getting-started, use the same slug for the translated version (e.g., /getting-started for German). This will help maintain link consistency. This is because when you add a redirect rule, the hyperlink URL text for English language is docs/en/article_slug and for German language is docs/de/article_slug.

Types of URLs

Absolute path/URL

An Absolute path/URL includes the entire web address, from the protocol (HTTP/HTTPS) to the domain name and the path within the site. It is the complete address required to access a specific webpage, regardless of the site you are currently on. An absolute URL is used when linking to external websites or when you want to specify the full address of a page.

For example: https://docs.document360.com/docs/v3/overview/interface

Relative path/URL

A Relative path/URL is a shortened version of the URL that only specifies the location after the domain. It assumes that the link is within the same site and shares the same root domain. The relative path always starts with a forward slash (/). It is commonly used for internal links within the same site.

In Document360, relative paths are used in several places, such as the linking feature in the editor, article redirect rules, tag redirect rules, and the ticket deflector.

For example: https://docs.document360.com/docs/v3/overview/interface

Relative path: /v3/overview/interface