Skip to content

Side view in Oxygen XML Editor which shows all outgoing (image references, links, content references) and incoming references for the current opened DITA topic

License

Notifications You must be signed in to change notification settings

oxygenxml/oxygen-dita-references-view-addon

Repository files navigation

Oxygen DITA References View

Side view in Oxygen XML Editor which shows all outgoing references and incoming references (only for Oxygen 23 or newer) for the current opened DITA topic. Available in the Editor and DITA perspectives.

The following outgoing references are presented in the side view for an opened DITA topic:

  • Image References (image with href or keyref)
  • Other media resources (DITA objects pointing to video, audio or embeddable frames)
  • Cross references (xref with href or keyref)
  • Key references (various elements with keyref)
  • Content References (conref or conkeyref)
  • Related links (link with href or keyref)
  • Related links defined in relationship tables (Oxygen 22 or newer)

The incoming references are presented for the current opened DITA topic. If a reference is expanded, the references to that topic will be displayed.

Features of the side view:

  • Side view user interface is translated in English, German, French, Japanese and Dutch.
  • Works both in the Author and the Text editing modes.
  • Selection in the outgoing references side view is synchronized with the caret location in the editor area for outgoing references.
  • Double click or ENTER on a reference to open the target location.

Installation

To 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.
  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 Install.
  5. Restart the application.

Result: A DITA References side-view will now be available. This side-view includes actions in the contextual menu to open the selected outgoing reference or show the definition location in case of a related link defined in a relationship table in DITA Map.

The add-on can also be installed using the following alternative procedure:

  1. Go to the Releases page and download the oxygen-dita-outgoing-references-view-{version}-plugin.jar file.
  2. Unzip it inside {oXygenInstallDir}/plugins. Make sure you don't create any intermediate folders. After unzipping the archive, the file system should look like this: {oXygenInstallDir}/plugins/oxygen-dita-outgoing-references-view-{version}, and inside this folder, there should be a plugin.xmlfile.

Copyright and License

Copyright 2019 Syncro Soft SRL.

This project is licensed under Apache License 2.0

About

Side view in Oxygen XML Editor which shows all outgoing (image references, links, content references) and incoming references for the current opened DITA topic

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages