Inserting DITA Map Topic References

Users can insert DITA topic references or other reference types (e.g., keys, other DITA maps) in DITA maps by using the Insert Topic Reference functionality in the Oxygen Desktop Plugin.

Users can only access the Insert Topic Reference tool in the main pane Editor'sAuthor mode for DITA maps. Keep in mind that the tool is context-sensitive. For example, if the user clicks an area in the DITA map that doesn't allow reference insertions, then the tool becomes inactive.

The Oxygen XML Editor application provides other built-in tools to insert DITA topic references. See the Oxygen XML Editor 24.0 Documentation or Oxygen XML Editor 23.1 Documentation for details about these build-in options.

To insert a topic reference in a DITA map via the DITA Maps Manager context menu:

  1. Open the Oxygen XML Editor application.
  2. Open the Checking Out DITA Content DITA Map in the main pane Editor.
    See Opening DITA Maps for details.
  3. Ensure Author mode displays as selected in the bottom-left area of the main pane.

    Author Mode

  4. Select the area of the DITA map where you will insert the topic reference.
  5. Choose one of the following steps.
    • Click DITA > Insert > Insert Topic Reference... in the Oxygen XML Editor toolbar (or press CTRL+Shift+I).

      Insert Topic Reference via Oxygen XML Editor Toolbar

    • Click Insert Topic Reference in the Oxygen Desktop Plugin toolbar (or press CTRL+Shift+I).

      Insert Topic Reference via Oxygen Desktop Plugin Toolbar

    • Right-click the area, and click Insert > Insert Topic Reference... in the context menu (or press CTRL+Shift+I).

      Insert Topic Reference via Maine Pane Editor Context Menu

    The Insert Topic Reference dialog displays.
    Do not use tools outside of the Ingeniux CMS Browser tab to create CMS DITA content items in the Oxygen XML Editor UI. These tools throw errors in the Oxygen Desktop Plugin. If you use outside tools to create content items, then restart the Oxygen XML Editor application to clear the errors.
  6. Insert a CMS resource in the URL field by completing the following steps.
    1. Select the URL field's browse folder drop-down arrow and select Browse CMS Content.
      The Select CMS Resource dialog displays.

      Browse CMS Content in Insert Topic Reference Dialog

      Select CMS Resource Dialog

    2. Navigate to and select the DITA topic (or DITA map) reference in the Browser tab tree structure. Click OK.
      The DITA map displays in the URL field, and the filepath automatically populates the Href field.
  7. Select an element ID attribute in the ID field to include an anchor in the topic reference.
  8. Complete the other tabs as needed in the Insert Topic dialog.
    See Oxygen XML Editor: Insert Reference Dialog Box for details about each tab and its features.
    Additional Information
    The Oxygen Desktop Plugin automatically generates values for the following attributes in the Attributes tab:
    @formatIdentifies the format of the reference (e.g., dita, ditamap).
    @navtitleProvides an alternate navigation title for the reference. This attribute users the reference's original title by default.
    @scopeIdentifies the scope (e.g., external, local, peer) of the reference in relation to the DITA map.
    @typeIdentifies the DITA type (e.g., task, concept, map) of the reference.
  9. Choose one of the following steps.
    • Select Insert to add the reference to the DITA map and keep the Insert Topic Reference dialog open to insert more references.
    • Select Insert and Close to add the reference to the DITA map and close the Insert Topic reference dialog.

      Insert and Close

  10. Save the DITA map to commit your topic reference insertion(s).