LanguageTool for oXygen

A LanguageTool plugin for oXygen XML Author.

Download and Install

oXygen:
- In the oXygen menu, open Help -> Install new add-ons...
- In the field Show add-ons from, add this URL: https://raw.githubusercontent.com/danielnaber/oxygen-languagetool-plugin/master/extensions.xml
- The LanguageTool add-on will be displayed. Follow the steps to install it and restart oXygen.
Without installing LanguageTool - this might be okay for you if you just want to test the plugin:
- In oXygen, go to Options -> Preferences... and on the LanguageTool Plugin page, check Use internet server
- Limitations: slower performance; will not work on large texts (>50KB) or on texts where checking takes more than 10 seconds; will send your texts over an encrypted connection to a LanguageTool server on the internet (see our privacy policy)
With installing LanguageTool:
- Start the LanguageTool stand-alone version.
- Go to Text Checking -> Options...
- Select Run as server on port 8081 and Use above settings for the server and click OK

Usage

Load an XML file and click the LanguageTool Check button or press Ctrl + Shift + Return. Errors detected by LanguageTool will become highlighted. Click the right mouse button on an error to get an error message and, for some errors, a list of corrections.

If something doesn't work, please start oXygen from the command line and see if you get any error messages there. Submit a bug report if you have problems.

Known Limitations

Basically, it simply checks anything not inside XML tags. As the logic for text extraction is different in Author mode and Text mode, this can sometimes lead to different error messages in both modes.
Does not work in Grid view.
Supports only one language per document. If it doesn't find a lang or xml:lang attribute, it uses the default language configured for the spell checker.
There's no "ignore" option for individual errors.
In Text mode:
- Will not properly work on XML that is not well-formed
- Entities are not expanded
Tested with oXygen 16.1 only.

Building

Building the source code requires Java 6 or later, Maven, and your .m2/settings.xml to be set up as described here. Call mvn package, then unzip the resulting target/oxygen-languagetool-plugin-(...)-plugin.jar to a sub-directory of your oXygen's plugins directory and restart oXygen.

The LanguageTool wiki contains internal release documentation.

Thanks to oXygen XML for providing me with a free license.

Changelog