Using Xref and Xref Target Tags

This topic describes how to use Xref tags to make a general reference to another section in the same document.

Creating an Xref Target explains how to create the target that you want to reference elsewhere. Referencing an Xref Target describes how to use XrefTarget tags to reference a specific piece of information, such as an address or text from another section.

The type of Xref determines how the information is presented. For example, a Title would appear italicised in the referenced text.

Creating an Xref Target

This procedure explains how to tag content with an XrefTarget in order to reference the content in another location.

  1. Double-click the text of an element to open the text editor and then select the desired text.

  2. Right-click the selected text and select Wrap in 'XrefTarget' Tag.

  3. Enter a name for your reference in the XrefTarget Name prompt.

    The selected text is tagged with the XrefTarget tag and also displays the name of the reference.

Referencing an Xref Target

This procedure explains how to reference (include) text from an existing Xref.

  1. Within the text editor, place the cursor where you want to add the Xref. Note: The red box below indicates the cursor location for this example.

  2. Right-click the location you wish to place the reference and select Add Xref.

    The Xref is created, but unlinked. Continue with the next steps to link the Xref to the desired target.

  3. Right-click the Xref and select Link To and then select the desired target.

    The Xref displays the name of the target to which it is now linked.

  4. Select Link and then select the type of formatting the link is to receive when the document is built.

    Note:
    • If the selected Link is Number and Title, you can optionally select a number style.

    • Failure to select the formatting type will omit the Xref content from the output.
    • Assigning a formatting type other than what is legal for the element in which the Xref resides results in the Xref content being omitted from the output. For example, assigning a type of Title to an Xref that resides within a para element produces no content.
    • Viewing the results in the Previewing a Document verifies the Xref will appear as desired.