[Editor Plugin] LanguageTool

[Doitsu]

This plugin allows you to run a grammar check on the currently open HTML file with LanguageTool.

Credits:

Kovid Goyal who helped me with the Calibre API.

Disclaimer:

Since I'm not a programmer you might want to save your books before having them checked by this plugin. (The plugin will also automatically create a checkpoint.)

Installation:

This plugin requires Java. To test whether Java is installed on your machine open a command prompt/terminal window and enter the following command:

java -version

If you don't get a version number, Java is either not installed or the Java binary can't be found. If Java is not installed, go to the Oracle website and download the latest Java version. (Note that you might need to re-boot your machine after the installation.)

You'll also need to download and unzip the desktop version of LanguageTool. (When you run the plugin for the first time you'll be prompted to select languagetool-commandline.jar, which is located in the LanguageTool root folder.)

Usage:

Simply open an HTML file and click the LanguageTool icon. If LanguageTool finds any errors, the plugin will display them in a new window.

For example, if you check: It don't matter to me. the plugin will display the following message.

... It don't matter to me.... GRAMMAR:HE_VERB_AGR The pronoun 'It' is usually used with a third-person or a past tense verb: 'doesn't', 'didn't'

(GRAMMAR is a LanguageTool category and HE_VERB_AGR a LanguageTool rule.)

Note that the plugin will use the value of the <dc:language> metadata entry for all files in the book. I.e., lang/xml:lang attributes will be ignored.

Settings:

The plugin doesn't come with a GUI, however, advanced users can change some of the default settings by editing LanguageTool.json, which will be created in the Calibre plugins folder (Preferences > Miscellaneous > Open Calibre configuration directory > plugins).

{
  "update_check": false, 
  "close_cb": false, 
  "allFiles": false, 
  "clipboard_copy": false, 
  "ltPath": "C:/Program Files/LanguageTool-4.3/languagetool-commandline.jar", 
  "disabledRules": "MORFOLOGIK_RULE_EN_US,ENGLISH_WORD_REPEAT_BEGINNING_RULE,
  "disabledCategories": "REDUNDANCY" 
}

• update_check: If enabled, the plugin will check the LanguageTool GitHub website for LanguageTool updates.
• close_cb: If enabled, the plugin will automatically close the Check Book window.
• allFiles: If enabled, the plugin will check all HTML files.
• clipboard_copy: If enabled, the plugin will copy all error messages as a tab-delimited file to the system clipboard.

Troubleshooting:

If you get a WindowsError: [Error 2] unhandled exception message, the Java binary couldn't be found. Installing/updating Java and re-booting your machine should take care of this problem.

If you check a very large file, Windows might display (Not responding) in the title bar. This is normal. You'll have to wait until the check is completed.

Version History

Spoiler:

Version 0.1.0 - 08 Dec 2018
Initial release.

[jbacelar]

Wow!
Thank you very much Doitsu.
I will try it today.

[jbacelar]

Works very well.
Thanks again.

[thiago.eec]

Thanks, Doitsu!
Works perfectly, with support for pt-BR.