Edit online

Resolving Topic References Through an XML Catalog

There are situations where you want to resolve references with an XML Catalog:

  • You customized your DITA map to reference topics using URIs instead of local paths.
  • You have URI content references in your DITA topic files and you want to map them to local files when the map is transformed.

In such situations, you have to add the catalog to Oxygen XML Editor Eclipse plugin. The DITA Maps Manager view will solve the displayed topic refs through the added XML catalog URI mappings. The resolution through the XML catalog URI mappings are done only for reference values starting with the urn: prefix.

To add an XML catalog to the DITA framework, follow these steps:
  1. Create an XML catalog using the guidelines described in Working with XML Catalogs.
  2. Open the Preferences dialog box and go to Document Type Association.
  3. Select the DITA document type and use the Edit, Duplicate, or Extend button to open a Document type configuration dialog box.
  4. Go to the Catalogs tab.
  5. Click on the Add button to open a dialog box that allows you to add your created XML Catalog to the list.
  6. After adding your catalog, click OK. You may need to reopen any currently edited files that use the new catalog or run a manual Validate action for the changes to take effect.
    Note: You could also add your created catalog to the list of global catalogs in the XML Catalog preferences page.

Adding a Custom URI Resolver to Oxygen XML Editor Eclipse plugin

You can use the XMLUtilAccess.addPriorityURIResolver(URIResolver) API to add your own priority URI resolver from a Workspace Access plugin extension, allowing you to take control over how topic references in a DITA map are located or how references in DITA topics are resolved.

Publishing a DITA Map with References Resolved Through the XML Catalog

If you are publishing a DITA map that contains references to topics that need to be resolved through the XML catalog support in Oxygen XML Editor Eclipse plugin, you must enable the fix.external.refs.com.oxygenxml parameter in the Parameters tab of the transformation scenario configuration dialog box.