Development Resources

Author SDK for Standalone & Eclipse distributions

In order to develop a framework (an Author document type) with custom Author actions and extensions for the Author Visual mode of <oXygen/> XML Editor you will need the Author SDK. This is a zip archive that contains the Author API as Javadoc documentation and the source code (as sample code) of all the actions that are present in the following default document types of <oXygen/>: DITA, DocBook, TEI and XHTML. The Author SDK can be deployed also between multiple <oXygen/> Author installations.

The Javadoc of the Author API is also available online and as a zip archive.

The latest API changes introduced by the current <oXygen/> version are available here.

The Author Developer Guide is a chapter of the <oXygen/> User Guide.

Author Component for standalone Java/Swing or Web based integrations

The Author SDK can be used to integrate the visual <oXygen/> Author page in your own Swing applications. One common use case is to embed the Author component as a Java Applet in a Web application (CMS front end). The author component startup project contains the Author SDK and basic resources for getting started with integrating the Author Component as a Java Applet.

For an online demo applet click here.

Other resources:

Author Component Developer's Guide

Eclipse SDK for Eclipse plugin integrations

This additional API is provided for easily accessing the opened XML Editors from your own Eclipse plugins. You can check which pages are active in the opened XML editors, modify them or add listeners to notify custom views which can provide additional context information. For instance it is possible to access the document model from the Author page directly from your plugin, using most of the Authoring API.

A complete Eclipse project with Javadoc documentation for the editor access API and several extension points together with sample sources, libraries and a plugin descriptor are available for download as a software development kit.

Plugins API for Standalone distribution

In order to develop plugins for the <oXygen/> standalone distribution you will need the following files:

The sample plugins are also available in compiled form. They can also be installed through the add-ons support, being available as add-ons deployed at http://www.oxygenxml.com/InstData/Addons/optional/updateSite.xml.

ConversionConfigurable conversion plugin. Comes with a sample configuration mapping between metric system and U.S. system.
Capitalize linesThis plugin capitalizes the first letter found on every new line that is selected. Only the first letter is affected, the rest of the line remains the same. If the first character on the new line is not a letter then no changes are made.
Form SentencesThis plugin capitalizes the first letter of every sentence in the selected text from the document.
Form WordsThis plugin capitalizes the first letter in every word in the selected text from the document. Only the first letter is affected, the rest of the word remains unchanged. If the first character in the word is not a letter then this plugin has no effect.
Lower CaseThis plugin converts every character in the selected text to lowercase.
Upper CaseThis plugin converts every letter in the selected text to uppercase.
Startup This plugin allow customization of the editor's menus, toolbars, and some other user interface components.
XML CommentThis plugin encloses the selected text in the document in an XML comment block.
Custom ProtocolThis plugin provides a Java URL stream handler for a custom protocol able to handle URLs of the form: cproto://path/to/file.ext where cproto is the protocol handled by the plugin.
Zero IndentThis plugin removes the whitespaces that start each of the selected line.
Format PreserveA special case of format and indent of the selected XML content that formats by breaking only in element tags and never in text nodes.
Workspace AccessThis plugin provides support for customizing the content of the menus, toolbars and views of the application and for opening and closing documents. You can manage and perform different operations on all the opened editors.
Open RedirectThis plugin is useful for opening more than one file with only one open action. For example when a zip archive, an ODF file or an OOXML file is opened in the Archive Browser view the plugin can decide to open also a file from the archive in a new XML editor panel. This file can be the document.xml main file from an OOXML file archive.

Follow the instructions of the plugins manual PluginDeveloperGuide.pdf for testing any sample plugin or for developing a new plugin and deploying it in <oXygen/>.

XProc API

<oXygen/> offers a public API that can be used to implement support for an XProc engine that then can be used from oXygen to execute and also possibly validate XProc pipelines. The development procedure is described in the user manual, please see the Integration of an external XProc engine - the XProc API section.

API History

The API distributions listed in this page are compatible with the <oXygen/> version 15.2. If you are developing for older <oXygen/> versions you may consider using the corresponding API version:

Video Tutorials
" oXygen XML Editor is the premier text editor for XML geeks, and an indispensable tool for O'Reilly's Production group. My team uses oXygen XML Editor for everything from simple XML editing to Schema validation and XSLT transformations. The digital production staff especially loves oXygen's built-in EPUB support, which eliminates a great deal of the grunt work that is usually entailed in editing EPUB files. The more we use oXygen, the more realize what a powerful tool it can be in digital and XML-based workflows."
Adam Witwer
Director of Content and Publishing Operations
O'Reilly Media