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-16.1.3-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:
In order to be compatible with all oXygen packages and installations, on all supported operating systems, the Java extensions in the SDK need to be compiled with Java 1.6 compatibility.
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 http:/oxygenxml.com/maven/. You should configure this repository in your Maven settings as explained below.
First configure Maven to use oXygen SDK repository. You can do this by adding the following snippet in the .m2/settings.xml file used by Maven. The settings file is typically found in the user home directory.
<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"> <!-- ... Other settings .... --> <profiles> <profile> <id>oxy</id> <activation> <activeByDefault>true</activeByDefault> </activation> <repositories> <repository> <id>public</id> <name>oXygen public artifacts</name> <url>http://www.oxygenxml.com/maven</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>true</enabled> </snapshots> </repository> <!-- ... Other repository definitions ...--> </repositories> </profile> </profiles> <!-- ... Other settings .... --> </settings>
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 archetype:generate \ -DarchetypeGroupId=com.oxygenxml.samples \ -DarchetypeArtifactId=oxygen-sdk-samples-archetype \ -DarchetypeVersion=16.1.3 \ -DgroupId=myGroup \ -DartifactId=mySample \ -Dversion=1.0-SNAPSHOT
Confirm that the details are correct by pressing ENTER. Maven will generate a sample project called mySample. The final project has the following modules:
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.