Edit online

How to Configure Oxygen XML Author for Other S1000D Versions

Oxygen XML Author includes built-in support for S1000D 4.x versions by default. It is possible to integrate other S1000D schema versions (2.x, 3.x, 5.x, 6.x) with some manual configuration.

This best practices guide provides instructions for integrating S1000D 2.x, 3.x, 5.x, and 6.x schemas into Oxygen XML Author, covering both the customization of built-in frameworks as well as methods for creating your own catalogs for maximum flexibility and compatibility.

Step 1: Download the Required S1000D Schemas

First, download the official XML schemas directly from s1000d.org. The directory structure varies by version:

  • S1000D 6.0: S1000D Issue 6\S1000D Issue 6 XML Schema Package\S1000D 6 XML Schema Package\xml_schema_flat

  • S1000D 5.0: S1000D Issue 5.0\S1000D Issue 5.0 XML Schema Package\S1000D 5.0 Final - XML Schema Flat and Support Files\xml_schema_flat

  • S1000D 3.0: S1000D Issue 3.0\XML-SGML Schema-DTD package\S1000D_3-0_xml_schema\S1000D_3-0\xml_schema_flat

  • S1000D 2.x: S1000D Issue 2.x\XML-SGML Schema-DTD\package\S1000D_2-x_xml_schema\xml_schema

For legacy data, or certain S1000D 2.x and 3.0 scenarios, you might need to use DTD-based validation.

  • S1000D 3.0 (with DTD): Retrieve the following folders:

    • S1000D Issue 3.0\XML-SGML Schema-DTD package\S1000D_3-0_xml_dtd\S1000D_3-0\ent

    • S1000D Issue 3.0\XML-SGML Schema-DTD package\S1000D_3-0_xml_dtd\S1000D_3-0\xml_dtd

Important:
Use XML files that conform to the DTD structure. Do not use SGML-based files.

Step 2: Integrate Schemas with Oxygen

Method A: Modifying Built-in Frameworks

If you have permissions set to alter Oxygen’s built-in frameworks, you can redirect schema resolution for a streamlined editing experience:

  1. Navigate to the built-in schemas directory: oxygen/frameworks/s1000d_base/schemas.

  2. Create a schema folder per version:

    • For example, if working with S1000D 5.0 and your XML uses xsi:noNamespaceSchemaLocation="http://www.s1000d.org/S1000D_5-0/xml_schema_flat/comrep.xsd", then create a folder named S1000D_5-0 under schemas/.

    • Copy your downloaded xml_schema_flat into this directory.

  3. Update the schema catalog:

    • Open oxygen/frameworks/s1000d_base/catalog.xml.

    • Add entries to map the online S1000D namespace to your local schema directory:

      <rewriteSystem systemIdStartString="http://www.s1000d.org/S1000D_5-0/" 
     rewritePrefix="schemas/S1000D_5-0/" />
<rewriteURI uriStartString="http://www.s1000d.org/S1000D_5-0/"  
     rewritePrefix="schemas/S1000D_5-0/" />

    • Repeat for each version as necessary.

Method B: Creating a Custom XML Catalog

If modifying internal frameworks is not an option, you can create your own catalog and schemas folder in a writable location:

  1. Create the directory structure:

    • Make a folder wherever you have write permissions.

    • Inside the new folder, create a schemas folder and version-specific subfolders, such as schemas/S1000D_5-0/.

  2. Copy your downloaded xml_schema_flat file into the relevant subfolders.

  3. Create a catalog.xml file:

    • Add the following content, adjusting versions as needed:

      <?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
  <rewriteSystem systemIdStartString="http://www.s1000d.org/S1000D_5-0/" 
       rewritePrefix="schemas/S1000D_5-0/" />
  <rewriteURI uriStartString="http://www.s1000d.org/S1000D_5-0/" 
       rewritePrefix="schemas/S1000D_5-0/" />
</catalog>

    • Add entries for each S1000D version needed.

  4. Register the custom catalog in Oxygen:

    • Go to Options > Preferences > XML > XML Catalog.

    • Click Add, and enter the path or URL to your custom catalog.xml.

Step 3: Document Type Association for Legacy Versions

To integrate older versions, such as S1000D 2.x or 3.x, follow similar steps. However, note that the S1000D framework provided by Oxygen may not fully support these versions because of differences in schema syntax. You can improve the support by creating a custom framework with a higher priority than the default framework, which is typically set to Low.

For advanced customization:

  • Navigate to Options > Preferences > Document Type Association in Oxygen.

  • You can extend or duplicate the existing S1000D document type.

  • Increase the priority of your custom framework so that it takes precedence over the default framework.

  • Customize your framework by updating the CSS and actions. For more details, see Creating and Configuring a Custom Framework.