Development ResourcesAuthor SDK for Standalone & Eclipse distributionsIn 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 integrationsThe 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 integrationsThis 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 an sample development
kit. Plugins API for Standalone distributionIn order to develop plugins for the <oXygen/> standalone distribution you will need
the following files: The sample plugins are also available in compiled form
only. | Conversion | Configurable conversion plugin. Comes with a sample configuration mapping between
metric system and U.S. system. | | Capitalize lines | This 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 Sentences | This plugin capitalizes the first letter of every sentence in the selected text
from the document. | | Form Words | This 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 Case | This plugin converts every character in the selected text to lowercase. | | Upper Case | This 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 Comment | This plugin encloses the selected text in the document in an XML comment block.
| | Custom Protocol | This 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 Indent | This plugin removes the whitespaces that start each of the selected line. | | Format Preserve | A 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 Access | This 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 Redirect | This 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. | | UUID Generator Plugin | Developed by André Müller. This plugin inserts an UUID in the canonical
format at cursor position. |
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/>. Diff Component SDK for Java integrationsThe <oXygen/> XML Diff Component is a Java component that can be integrated in a
server or desktop application and enhance it with XML differencing capabilities. The SDK
(Software Development Kit) contains the necessary Java libraries, the API sources,
documentation and samples to get development started and can be downloaded from here. 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 HistoryThe API distributions listed in this page are compatible with the <oXygen/> version
13.2. If you are developing for older <oXygen/> versions you may consider
using the corresponding API version: | 
data server software 
