Document references panel

Key point: View what’s linking to your document and what your document links to.

The document references panel lets you view the links and xrefs in relation to the current document in the following separate tabs:

  • Incoming – xrefs from other documents to the current document. They are also called reverse xrefs.
  •  Xrefs – xrefs from the current document to other documents.
  •  Links – links to external websites.
  • Images – links to images contained in the current document.

If there are any incoming references, we display how many there are, in a red circle, in the left sidebar next to the icon. This lets you know that the current document is referenced by other documents.

Incoming references tab

This tab lists xrefs from other documents to the current document. By default, they are grouped by source document title. Click the By fragment switch to sort by source fragment. There are other grouping possibilities depending on the type of xref.

Click the document link to go to the source document or click the  icon to preview that document in the document panel.

For each incoming reference:

  • In bold – the text of the xref as it appears in the source document.
  • In italics following “from” – the reverse title if one is specified and different from the document title.
  • In italics following “to” – the target of the xref, that is, where the xref points to in the current document. This might be the page number, the heading of the target fragment or “this document”.
  • If the target of the xref is a fragment or a page, you can click the   icon to see what part of the current document the xref links to.

For developers: Incoming references correspond to the reversexref element in PSML.

Xrefs tab

This tab lists xrefs from the current document to other documents, grouped by target document.

Click the document link to go to the target document or click the icon to preview that document in the document preview panel.

For each outgoing reference:

  • The link text as it appears in the source document – click this link to go to the target document.
  • In italics following “to” – the page number if there is one.
  • In italics following “from” – the reverse title if one is specified or the heading of the fragment.
  • Click the icon to see where the xref is in the current document.

For developers: XRef references correspond to the xref and blockxref elements in PSML.

Links tab

The list of links from the current document to external websites, grouped by domain name.

The domain name for the URL is followed by the number of links in the current document to that domain.

For each outgoing link:

  • The link text as it appears in the source document – click this link to go to the target URL document.
  • The path of the URL followed by an arrow – click this link to go to the URL.
  • Click the icon to preview that URL document in the document preview panel.
  • Click the icon to see where the link is in the current document.

For developers: Link references correspond to the link element in PSML.

Images tab

We display the list of images referenced in the document.

For each image:

  • Click the image filename at the bottom of the image to go to the document.
  • Click the icon to preview that image document in the document preview panel.
  • Click the icon to see where the image is in the current document.

For developers: Image references corresponding to the image element in PSML.

How to find this page

When viewing a document, click the icon at the top of the left sidebar.