Oxygen XML Editor
The Premier All-In-One XML Editing Suite
Oxygen XML Author
Single-Source XML Authoring and Multi-Channel Publishing
Oxygen XML Developer
The Required Tools for Designing XML Schemas and Transformation Pipelines
Oxygen JSON Editor
The Perfect Tool to Simplify Your JSON Editing Experience
Oxygen Publishing Engine
The Complete DITA Publishing Solution for WebHelp and PDF Output
Oxygen PDF Chemistry
Chemistry Converts HTML and XML to PDF Using CSS
Oxygen XML WebHelp
Publish DITA Content to WebHelp Output
Oxygen Styles Basket
Customize the Look and Feel of Your PDF and WebHelp Output
Oxygen XML Web Author
Engage Your Whole Organization In Content Creation
Oxygen Content Fusion
The Web-based Collaboration Platform to Craft Tomorrow's Content
Oxygen Feedback
Modern Commenting Platform
Cloud
Enterprise
Oxygen AI Positron
Enhance Your Productivity with the Power of AI
Oxygen Scripting
Automate and Run Oxygen Utilities from the Command-Line Interface
Oxygen SDK
Specifically designed for application developers and integrators
Shop
Pricing and licensing for businesses, Academic and individuals
Oxygen makes its SDK available as a set of Maven artifacts. An archetype is provided that can be used as a base to develop Oxygen frameworks, plugins, and Eclipse plugin integration. It can also be used to create projects that use the Author Component. For each specific task, you can find more details in the sections that follow.
The latest API changes that were introduced by the current version of Oxygen are available here.
The Oxygen SDK provides support for creating Oxygen plugins, frameworks project development, as well as other integrations. The SDK is a collection of Maven artifacts and archetypes. It allows you to leverage the vast number of Maven plugins for your Oxygen project and integrates it easily with your current development process.
In case your build system is not based on Maven, you can download the package with all the Oxygen SDK jar files: oxygen-sdk-27.0.0.0-all.zip
A multi-module startup project is available. It allows you to customize any aspect of the Oxygen XML-editing platform. The startup project archetype does not require additional download and provides a perfect starting point for any Oxygen XML customization project.
The Oxygen SDK offers support for:
The Author SDK startup project is available as a Maven archetype with the following details:
The archetype is available from Oxygen's public repository located at https://oxygenxml.com/maven/. You should configure this repository in your Maven settings as explained below.
Make sure that Maven can access the Oxygen repository. If your organization uses an HTTP proxy server, you need to specify it in the .m2/settings.xml configuration file:
<!-- ... Other settings .... --> <proxies> <proxy> <id>myproxy</id> <active>true</active> <protocol>http</protocol> <host>proxy.mycompany.com</host> <port>3128</port> <username></username> <password></password> <nonProxyHosts>localhost,127.0.0.1</nonProxyHosts> </proxy> </proxies> <!-- ... Other settings .... -->
Follow this simple procedure to create a starting project based on the Author SDK:
Create a sample SDK project by typing the following in a command line console:
mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeGroupId=com.oxygenxml.samples -DarchetypeArtifactId=oxygen-sdk-samples-archetype -DarchetypeVersion=27.0.0.0 -DgroupId=myGroup -DartifactId=mySample -Dversion=1.0-SNAPSHOT -DarchetypeRepository=https://oxygenxml.com/maven/
Confirm that the details are correct by pressing ENTER. Maven will generate a sample project called mySample. The final project has the following modules:
C:\Users\<YOUR_USER_NAME>\.m2\settings.xml).
Update the settings.xml file from step (2) to contain:
<settings xmlns="https://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd"> <profiles> <profile> <repositories> <repository> <id>oxygenxml</id> <name>Oxygen XML</name> <releases> <enabled>true</enabled> <updatePolicy>always</updatePolicy> <checksumPolicy>fail</checksumPolicy> </releases> <snapshots> <enabled>true</enabled> <updatePolicy>never</updatePolicy> <checksumPolicy>fail</checksumPolicy> </snapshots> <url>https://www.oxygenxml.com/maven</url> <layout>default</layout> </repository> </repositories> </profile> </profiles> </settings>
The Eclipse J2EE IDE validates all the resources from the project, giving some false errors. To disable the automatic validation, follow these steps:
To create and build a sample project based on the Oxygen SDK, start from a Maven archetype available in the Oxygen repository.
In the Add Archetype dialog fill the data similarly to the screenshot below:
The source code of all the Java operations present in the DITA, DocBook, TEI, and XHTML Oxygen frameworks can be downloaded using the link below.
The API distributions listed in this page are compatible with the Oxygen version 27.0. If you are developing for older Oxygen versions, you may consider using the corresponding API version:
For older versions that have reached the end of life phase, please contact our support team at support@oxygenxml.com.