Links

  • Don’t link to an article that’s already referenced in another linked article.

  • External links must open in a new window.

    • In Markdown: [Title](URL){:target="_blank"}

    • In AsciiDoc: link:URL[Title^]

A trailing link is appended at the end of a sentence and has the following form:

(see targetLinkTitle)

Use a trailing link only when you can’t use an inline links.

In most cases, you can replace a trailing link with "If you (…​) see targetLinkTitle", which is better.

If you absolutely must use a trailing link, never include more than two links between the parentheses.

For more information, see Link to Coveo Technical Documentation.

This has been the recommended way to format links since January 2020.

Use inline links to avoid repetition. For example, instead of writing Access the Community Management Administration settings (see Access Community Management), write Access Community Management settings.

When possible, use the article or section title as the link text.

Use inline links for glossary entries.

Link text: exactly the glossary entry term (accepting singular or plural forms)

  • For concepts with acronyms, the link text should be the full product or technology names with the acronyms (Automatic Relevance Tuning (ART))

Link URL: {% glossarylink label=concept id=nnnn %}

  • Avoid using markup (that is, bold, italics, or monospace) in glossary link labels.

  • By default, on a given page, only the first instance of a glossary entry will render as a link.

  • If you want a glossary link to render more than once on a given page, you can override the default behavior by specifying the force_render option.

    Example: {% glossarylink label=activity id=173 force_render=true %}

In any article, typically link to glossary entries once, typically at the beginning of the article or sections when answering the "what" question.

  • Exception: can link to entries once per subsection when needed