Home
Extending Oxygen With the SDK
Information about extending Oxygen XML Editor using the SDK

Introduction
Welcome to the User Manual of Oxygen XML Editor 25.1
Getting Started
Information and resources to help you get started using Oxygen XML Editor as quickly as possible
Installation
The requirements and installation instructions for each platform
Configuration
Description of all of the options that allow you to configure Oxygen XML Editor
Perspectives
The Editor, XSLT Debugger, XQuery Debugger, and Database perspectives
Editing Modes
The Text, Grid, Author, and Schema Design editing modes
Working With Documents
General information about features available when working with documents
Editing Supported Document Types
Details about the various types of supported documents and their unique editing features
Built-in Frameworks (Document Types)
The editing frameworks that are supported in Oxygen XML Editor
Additional XML Editing Frameworks (Document Types)
The custom frameworks that are supported in Oxygen XML Editor
Publishing
Details about transformation scenarios and customizing various types of output
Working with XPath Expressions
Information about using XPath Expressions in Oxygen XML Editor
Working with Archives
Describes how to use the Archive Browser to work with various type of archives
Databases and SharePoint
Connecting to supported databases and integrating Oxygen XML Editor with SharePoint
Importing Data
Information about how to import data from external sources into XML documents
XSLT/XQuery Debugging
The debugging interface that detects problems with XSLT and XQuery transformations
Framework and Author Mode Customization
Tutorials and details about customizing frameworks and the visual Author editing mode
Extending Oxygen With the SDK
Information about extending Oxygen XML Editor using the SDK
Add-ons
Information about extending Oxygen XML Editor with add-ons
Tools
Specifics about the various tools that are included in Oxygen XML Editor
Troubleshooting
A compilation of common problems and their solutions
DITA Authoring
A guide to help content authors who create and publish DITA content
Scripting Oxygen
Details about the scripting possibilities that are available with Oxygen XML Editor
Glossary
Copyright
Legal information

Extending Oxygen With the SDK

Oxygen XML Editor has an SDK that can be used as a base to develop frameworks and plugins. It can be also used to create projects that use the Oxygen XML Author Component or Oxygen XML Web Author. The SDK is a Java library available under the Oxygen XML SDK licensing terms and is delivered with a set of examples that demonstrate how to extend Oxygen XML functionality through API calls. The SDK is available at https://www.oxygenxml.com/oxygen_sdk.html.

Important: From a legal standpoint, you can freely develop and share extensions using the Oxygen SDK ONLY if you have a legal, active license to use Oxygen XML Editor and ONLY if such extensions are used from inside Oxygen XML Editor. To use such extensions outside of Oxygen XML Editor (for example, a 3rd-party application that has Oxygen XML Editor built in to it), an additional license must be purchased to use the SDK according the Oxygen XML SDK Licensing Policy .