Table of Contents
User Guide
Cross-References
Cross-References
Cross-references (xrefs) are links to other files or external resources; they are direct links that are harder to maintain.
Inserting a Link to a File
You can create an inline link to a topic or map in the Content Library by using a cross-reference (XRef) link. Cross-references are direct links that lead you to supplementary information.
Inserting a Link to a Website or PDF
Cross-references (XRef) are inline links that lead you to supplementary information. Create a cross-reference link to an external source like a website or PDF.
Cross-References

Cross-references (xrefs) are links to other files or external resources; they are direct links that are harder to maintain.

Cross-references enable you to directly link to another file in easyDITA or external sources such as websites. Cross-references are direct links, so they are harder to maintain. For example, if the file is deleted then the link will no longer resolve. We recommend that you only use cross-references for external links.

section
Inserting a Link to a File

You can create an inline link to a topic or map in the Content Library by using a cross-reference (XRef) link. Cross-references are direct links that lead you to supplementary information.
Tip:We recommend using key references (keyrefs) instead of using cross-references to create a link to a topic. For more information, see Key References. If you’re trying to link to an external source, see Inserting a Link to a Website or PDF.

  1. In the Content Manager, open a topic and place your cursor where you want to insert a link.

    Step Information
    Note:By default, when you insert a XRef link, the topic’s title is used as the link text. This is rendered by easyDITA, so you don’t need to enter any text for the link.

  2. Click Link -> Xref .

    Expected Result
    An empty link element is inserted. The text is underlined and blue.
  3. Click Edit.

    Expected Result
    The Select Link window displays.
  4. Navigate to and select the file, and then click Select .

    Expected Result
    The link is inserted and the “XRef Link” placeholder is replaced with the topic’s title.
result

You inserted a direct link to another topic.

Note:You can change the link text by placing your cursor in the Xref link and entering new text. We do not recommend doing this because it makes link management difficult and tedious (E.g. the topic name changes). Custom link texts need to be maintained and modified each time the content changes and the link text is no longer relevant. This same change also has to be made every where the link is used.
Inserting a Link to a Website or PDF

Cross-references (XRef) are inline links that lead you to supplementary information. Create a cross-reference link to an external source like a website or PDF.
  1. In the Content Manager, open a topic and place your cursor where you want to insert a link.
  2. Click Link -> Xref .

    Expected Result
    An empty link element is inserted. The text is underlined and blue.
  3. Click Properties .

    Expected Result
    The Properties Pane displays. The properties for the XRef link display at the top.

  4. In the Source (href) field, enter the URL for the external source.

    Step Information
    The URL must contain http://. For example, http://www.google.com

    Source (href) field

  5. In the Scope drop-down menu, select external.
  6. In the Format field, enter the format of file expected at the link. For example, html or pdf.
  7. In the XRef Link element, enter text for the link.

    Example

result

You inserted a link to an external source.