Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Hyperlinks and cross-references

Updated on January 21, 2021

Use hyperlinks and cross-references to provide a user with links to related resources. You can also point the user to a different place in the document.

  • For all links and cross-references, apply the following general guidelines:

    1. Use the following sentence structure as the default one: For more information (about subject description), see Target content title with a direct link.

    2. Use the target topic or article title as the link display text. Do not use the entire URL as the display text.

    3. Do not add any additional characters in the URL to avoid breaking the link.

    4. Limit the number of inline links to reference only the content that is relevant and important.

      Inline links create dependencies between content. Use them sparingly and only when needed.
  • For parent topics (supertasks), use map linking to add automatic links to all the children topics that are nested under that parent.

    For more info about how to configure map linking, see TBD.
  • For references to pre- and postrequisite articles and topics, use the following format: After completing this and that, do this and that. See Target article or topic title with a link.

  • For references to Pega Community articles, create a hyperlink for the article itself in the following format:For more information, see the Article Title with a direct link article on Pega Community.

    Note: Do not use links with Node IDs. Instead, use the full alias URL.
    For example: For more information, see the Node classification article on Pega Community.
  • For references to additional topics or articles that are related to a given subject, as a best practice, add links by using the tag in your topics and the section in articles.

    • For DITA topics, add links in the related-links tag at the bottom of your topic.
    • For Community articles, define links in the Related Information section of your article.
    For more information, see TBD.
  • For references to a specific place in a document, create an ID for the target tag and link to that element in the xref(cross-reference) tag.

    For example: To define more links, repeat steps 1 through 3.
    For more information, see TBD.
  • For references to external websites, do not create direct links because these links are hard to maintain. If it is necessary to direct users to an external website for additional information, create a general cross-reference, but do not create a hyperlink.

    For example: For more information about the TCPMon proxy server, go to the Apache Axis website.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us