Edit online

DITA References View Add-on

Oxygen XML Author offers an add-on that contributes a DITA References side view that shows all outgoing and incoming references for the current DITA topic. Once the add-on is installed, the view is available in both Text and Author modes.

Quick Installation

You can drag the following Install button and drop it into the main editor in Oxygen to quickly initiate the installation process:

Install

Manual Installation

To manually install the add-on, follow these instructions:
  1. Go to Help > Install new add-ons to open an add-on selection dialog box.
  2. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu.
    Note: If you have issues connecting to the default update site, you can download the add-on package, unzip it, then use the Browse for local files action in the Install new add-ons dialog box to locate the downloaded addon.xml file.
  3. Select the DITA References View add-on and click Next.
  4. Read the end-user license agreement. Then select the I accept all terms of the end-user license agreement option and click Finish.
  5. Restart the application.

Result: Once installed, you need to restart Oxygen XML Author and the DITA References view becomes available. To open the view, select DITA References in the Window > Show View menu.

Outgoing References

The types of outgoing references that are presented in this view include:
  • Image references (referenced with an @href or @keyref attribute)
  • References to other media resources (DITA objects pointing to video, audio, or embeddable frames)
  • Cross references (referenced in an <xref> element with an @href or @keyref attribute)
  • Key references (referenced with a @keyref attribute)
  • Content references (referenced with a @conref or @conkeyref attribute)
  • Related links (referenced with an @href or @keyref attribute)
  • Related links defined in relationship tables

This side-view is synchronized with the main editor to make it easy to locate a reference in the current document. It also includes contextual menu actions for opening the target of an outgoing reference or showing its definition location. You can also double-click a reference to open its target.

Incoming References

The Incoming references tab shows all references to the current opened DITA topic.
  • The references are presented by taking both the Main Files support and the current context map configured in the DITA Maps Manager view into account.
  • The references are grouped into three categories: Map, Cross, and Content.
  • To open the target of a reference, you can double-click the references, or press Enter with the cursor located on the reference, or right-click the reference and choose Open reference.
  • To copy the location of the target of the reference, select the reference and press Ctrl + C (Cmd + C on Mac).
  • If a referenced topic is expanded, references to that topic are also displayed.
  • While editing a document, if changes appear that might influence how the references were computed, the Refresh button can be used to re-compute the references graph and show an updated list of incoming references.

For more information, see the details for the DITA Outgoing References View add-on in GitHub.

Resources

For more information about the DITA References add-on, as well as details regarding other popular add-ons that extend the functionality of Oxygen XML Author, watch the following webinars/presentations: