Developer
<oXygen/> XML Editor SDK
In order to create customizations for the Author Visual mode of
<oXygen/> XML Editor you will need the oxygenAuthorSDK.zip. The file
contains the Java API including HTML documentation and the source code of all the specific
actions that were used in the default customization of <oXygen/> for DITA, DocBook, TEI
and XHTML. The Developer Guide is also a chapter in the <oXygen/> User Guide.
Plugins
In order to develop plugins for the <oXygen/> standalone distribution you will need
the following files:
The 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. | | 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. |
Follow the instructions of the plugins manual HowToDevelopOxygenPlugins.pdf for
testing any sample plugin or for developing a new plugin and deploying it in <oXygen/>.
<oXygen/> as Eclipse plugin
The Eclipse plugin distribution of <oXygen/> exposes some sample extension points
which demonstrate how the <oXygen/> plugin can be extended by other Eclipse plugins:
- An action for locking/unlocking XML tag editing in the Oxygen XML Editor. The
action will be added to the toolbar associated with the Oxygen XML Editor and is
configured in the plugin.xml file.
- An action added to the context menu of the Oxygen XML Editor for replacing the
current selection in the editor with a text specified in the plugin.xml file.
- An action added to the context menu of the Outline view corresponding to the
current Oxygen XML Editor for selecting in the editor just the start tag of the node
selected in the Outline tree.
The Javadoc style documentation of the extension points together with the jar files, a
plugin descriptor and a build script necessary for building a sample Eclipse plugin which
extends the <oXygen/> plugin are available for download as an extensions development kit. We
welcome any feedback or suggestions about the extension points or the extensions development kit.
<oXygen/> Eclipse plugin extensions - example plugin
This is a complete Eclipse project for developing an Eclipse plugin providing extensions
for the <oXygen/> plugin. It comes with a build.xml file already
configured for building the extension plugin from a command line.
Spell-Checking Dictionaries
Installation
<oXygen/> provides dictionaries only for the languages English (EN, GB, CA, US), French
(FR, BE, CA, CH) and German in the form of .dar files located in the directory
[oXygen-install-dir]/dicts. Other dictionaries can be added by copying the corresponding
.dar archive to the same directory and restarting <oXygen/>.
Flute CSS Parser
<oXygen/> uses a modified version of the Flute
parser for parsing CSS 2 stylesheets. The Flute parser is Copyright © 2002 World
Wide Web Consortium, (Massachusetts Institute of Technology, Institut National de
Recherche en Informatique et en Automatique, Keio University).
Saxon 6.5 and Saxon 9 Processors
<oXygen/> uses modified versions of the original Saxon 6.5 XSLT processor and Saxon 9 XSLT and XQuery processor from
Michael Kay. The source code of the modifications added to the original processors is
provided for both Saxon 6.5 and Saxon 9. These modifications are subject
to the Mozilla Public License Version
1.0.
Other resources
-
UUID generator plugin - by André Müller
This plugin insert at the cursor position an UUID in the canonical format. See
the section of the
<oXygen/> User Manual about installing plugins.
Additional resources for <oXygen/> can be sent to .
| 
Mac OS X
Linux/Unix
