Integrating a DITA Specialization
Oxygen XML Web Author supports DITA specializations that allow you to design your own
markup. The DITA specialization can be defined with any of the following:
- DTD - For configuration and specialization tutorials, see http://dita4practitioners.github.io/dita-specialization-tutorials/.
- XSD - For configuration and specialization tutorials, see http://dita4practitioners.github.io/dita-specialization-tutorials/.
- Relax NG - For more information, see the following presentation: Creating DITA-OT Constraint/Specialization Plugins. For Relax NG coding requirements, see https://www.oxygenxml.com/dita/1.3/specs/archSpec/base/relax-ng-requirements.html.
To integrate a DITA specialization into Oxygen XML Web Author, follow this procedure:
- Open a standalone version of Oxygen XML Editor/Author.
- In a location where you have full write access, create a folder (for example, my_dita_framework).
- Create a folder inside your extended framework folder (for example, my_dita_framework/my_dita_specialization). This folder should contain your DTD or schema files and a catalog.xml file that references them.
- Create another catalog file inside the extended framework folder
(my_dita_framework/catalog.xml) that points to the catalog file in
your specialization folder. For example, this new catalog.xml file
should look like
this:
<?xml version="1.0" encoding="UTF-8"?> <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> <nextCatalog catalog="my_dita_specialization/catalog.xml"/> </catalog>
- Extend an existing DITA framework:
- Open the Preferences dialog box and go to . In this preferences page, add the path to the my_dita_framework folder in the Additional frameworks directories list and click Apply.
- Go to the Document Type Association preferences page and select an existing DITA framework configuration and use the Extend button to create an extension for it.
- Give the extension an appropriate name (for example, DITA - Custom), select External for the Storage option, and specify an appropriate path (for example, path/to/.../my_dita_framework/dita-custom.framework).
- In the Catalogs tab, add a new entry with the catalog file that you created above.
- Click OK to close the dialog box and then
OK or Apply to save the changes.Tip: For more information about framework customization, see Integrating Web Author with Your Content by Creating Custom Frameworks.
- Create an archive that contains your extended framework folder (for example, my_dita_framework). The archive should contain exactly one folder on the first level.
- Upload the framework to Web Author.
Tips:
- For a resource to help you with creating the DITA specialization, see the DITA for Practitioners DITA Configuration and Specialization Tutorials.
-
If you need to define custom profiling attributes in your specialization, the
domains
attribute of the root element should contain:a(props ATTR)
where ATTR is the name of the custom profiling attribute.