Links

In Gramax, you can create both relative and absolute links using the visual editor.

Relative links are used to link to other articles within the catalog. For example, a link to the release notes. Relative links are automatically updated when articles are moved in the navigation or if an article URL changes.

Link to an Article

To add a link: select the word, click the link icon , and choose the article.

Link to a Heading within an Article

To add a link: select the word, click the link icon . Then choose the article and the heading within it.

When clicking on the link, the article will open directly at this heading rather than the beginning.

Link to an article from another catalog

To add a link: select the word, click the link icon , then click Other catalogs. Next, choose the catalog and the article.

Absolute links are links to a specific online resource: for example, to our site.

To add a link: select the word, click the link icon , and insert the URL.

If you edit the link text and it matches its URL, the URL will be updated automatically. If the text and the URL are different, the URL will remain unchanged.

To create a clickable link for calling a phone number or sending an email:

  1. Highlight the text you want to turn into a link.

  2. Click the link icon in the toolbar.

  3. Enter the following formats:

    • Phone: tel:+1234567890

    • Email: mailto:example@email.com

This ensures users can quickly call or email directly from your documentation.

Preview the Article

Article previews allow you to view content before opening it. To do this, hover over the relative link. Previews work on hover in both the editor and the reader portal.

Previews are useful when you need to explain a specific term. Create a separate article for the term and link to it.