Edit online

Working with DITA-Compatible Documents

Oxygen XML Editor includes powerful dynamic publishing features that allow you to easily integrate Word, Excel, OpenAPI, HTML, Markdown documents into a DITA project and have them automatically converted to DITA at the time of publishing. This is especially helpful for teams that have contributors who work with non-DITA documents but want their output to be generated from DITA projects.
Attention:
These features are available with no restrictions when the publishing process is done using the default publishing engine that is bundled in Oxygen XML Editor or if you have integrated the DITA-OT dynamic converter plugin into a custom DITA-OT distribution.

Working with DITA-Compatible Documents in the DITA Maps Manager

Oxygen XML Editor has some specialized features that allow you to integrate DITA-compatible documents directly into your DITA project using the DITA Maps Manager. The following features are available in the DITA Maps Manager view:

  • Insert References to DITA-Compatible Documents - You can use the New, Reference, and Reference to the currently edited file actions from the Append Child, Insert Before, or Insert After submenu when invoking the contextual menu in the DITA Maps Manager to insert a reference to a Word, Excel, OpenAPI, HTML or Markdown document at the selected location in the map. A topic reference (<topicref>) element with the appropriate @format attribute value will be inserted.
  • Title of Referenced Resources is Displayed - The title of each referenced DITA-compatible resource is presented in the DITA Maps Manager view.
  • Validate DITA-Compatible Documents in DITA Maps - When you use the Validate and Check for Completeness action from the DITA Maps Manager toolbar to check the integrity of the structure of a DITA map, DITA-compatible documents that are referenced in the DITA map are converted to DITA topics in the background and validated the same as any other DITA topic.
  • IDs Presented When Inserting References - When inserting topic references, cross references, or content references to content inside DITA-compatible documents, the application presents a list of DITA-specific IDs from the target document.
  • Transform DITA Maps with DITA-Compatible Documents - When transforming DITA maps that have DITA-compatible documents referenced, the transformation converts the documents to normal DITA output without you needing to manually convert the documents to DITA topics.

Converting Multiple DITA-Compatible Documents to DITA

Oxygen XML Editor offers an add-on that contributes actions in the Tools menu and contextual menu to enable batch conversions between various formats. For more information and instructions for installing the add-on, see Batch Documents converter add-on.

Resources

For more information about working with DITA-compatible resources, see the following resources: