How to create an xref to a document

Key point: Create an xref to a document.

Prerequisites

You must have a role of contributor or higher and viewing a document in edit mode.

1 Open xref dialog

To insert an xref, open the xref dialog:

  1. Place cursor in position where link is wanted; you can highlight the words that you want to use for the link title or for looking up documents.
  2. Then,
    1. Click the xref icon icon in the document toolbar, OR
    2. Right-click with the mouse to bring up the editing context menu and select the Cross-reference option, OR
    3. Use Control+K (or Command+K on MacOS) keyboard shortcut.

2 Create xref

  1. Select the Configuration field – generally, use Default.
  2. Find a target document – you can choose from the following:
    1. If no words for the link title were selected, a number of documents in the group display. Click a document to select it as the target document, OR
    2. Type in the Search documents field to display suggested documents, then click a document to select it as the target document. Click the checkbox to match any content.
    3. You can opt to choose a different group to search for document in – type a group name in the field at the far right of the dialog. Click a group to select it.
    4. Click the  folder-tree icon Browse icon. You can then:
      1. Navigate to your target document, then click the document to select it as the target document, OR
      2. Create a new document to xref to. At the left, click to select the folder you want to create the new document in, then follow steps 3 to 6 in how to create a document.
  3. Click the Select this document button to xref to the whole document, or click a fragment in the document to xref to only that fragment.
  4. You now see the Edit view in the xref dialog. Edit the fields in the dialog if needed.
  5. Click the Save button at the bottom to create the xref.
lightbulb icon

Alternatively, you can skip the xref dialog and use a keyboard shortcut to quickly and directly insert an xref in your content; this option uses the Default configuration.

Place your cursor at the position you want to insert an xref, insert an ‘@’ character then type the first letter/s of the document title of the target document (or any letter in the title). Click the wanted title in the list of auto-suggestions to insert that title as the link title.