[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-5.0/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.3 - 20 April 2024
LanguageTool 6.x support added.
Version 0.1.2 - 2 Jan 2022
PyQt6 support added.
Version 0.1.1 - 07 Jul 2020
Python 3 support added.
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.

[icallaci]

This tool saved me a ton of work on a very poorly edited book. Thank you.

[dunhill]

Hello people, I want to try the plugin and it gives me the following error. My language is Spanish, how should I configure the LanguageTool.json file?
In linux mint 19.2

[Doitsu]

Originally Posted by dunhill

Hello people, I want to try the plugin and it gives me the following error. My language is Spanish, how should I configure the LanguageTool.json file?
In linux mint 19.2

Unfortunately, I don't have access to my computer right now. Based on the status message, either your Java version or your Languagetool version is incompatible.
Did you download the latest Languagetool desktop version from the official website or via your Linux package manager?
What's your Java version?
What's your Languagetool version?

If you have the latest versions installed, try changing the values of the disabledCategories and disabledRules JSON file entries to "". (I.e., delete them.)

[dunhill]

Originally Posted by Doitsu

Unfortunately, I don't have access to my computer right now. Based on the status message, either your Java version or your Languagetool version is incompatible.
Did you download the latest Languagetool desktop version from the official website or via your Linux package manager?
What's your Java version?
What's your Languagetool version?

If you have the latest versions installed, try changing the values of the disabledCategories and disabledRules JSON file entries to "". (I.e., delete them.)

What's your Java version? Java version attached
languagetool-commandline-2.2.jar ( 4.7)

File Json
{
"allFiles": false,
"clipboard_copy": false,
"close_cb": false,
"disabledCategories": "REDUNDANCY",
"disabledRules": "MORFOLOGIK_RULE_EN_US,ENGLISH_WORD_REPEAT_BEGINNI NG_RULE",
"ltPath": "/home/walter/languagetool-commandline.jar",
"ngramIndexDir": false,
"update_check": false
}

modified to:
{
"allFiles": false,
"clipboard_copy": false,
"close_cb": false,
"disabledCategories": ,
"disabledRules": ,
"ltPath": "/home/walter/languagetool-commandline.jar",
"ngramIndexDir": false,
"update_check": false
}


I have reinstalled LanguageTool-4.7 and I wanted to inform you that the plugin works thanks for your work,Doitsu

[Capricorn]

Computer: windows 11 with the latest updates
Calibre 7.8
Sigil editor 2.1.0
Language Tool Plugin: latest version
Language Tool version 5 and version 6

When I use the language Tool Plugin with version 5 of the language tool, it works without problem in the Calibre Editor and in Sigil Editor. However, when I use the plugin with the language Tool version 6, it does not work in Calibre Editor, but it does work in sigil editor.
In the Calibre editor, I get the following error message: see attachment

Is there a way to solve this?

[theducks]

Originally Posted by Capricorn

Computer: windows 11 with the latest updates
Calibre 7.8
Sigil editor 2.1.0
Language Tool Plugin: latest version
Language Tool version 5 and version 6

When I use the language Tool Plugin with version 5 of the language tool, it works without problem in the Calibre Editor and in Sigil Editor. However, when I use the plugin with the language Tool version 6, it does not work in Calibre Editor, but it does work in sigil editor.
In the Calibre editor, I get the following error message: see attachment

Is there a way to solve this?

@Cap, It would be easier on us if you simply copied (to clipboard) and pasted the error log into a Spoiler tag pair (eye X'd out on the advanced edit bar)

[Doitsu]

Most likely, in the latest version of LT some of the command line parameters changed. I'll have a look at this and'll release updated versions of the plugins.

[Capricorn]

Originally Posted by theducks

@Cap, It would be easier on us if you simply copied (to clipboard) and pasted the error log into a Spoiler tag pair (eye X'd out on the advanced edit bar)

I tried to copy/paste the error message. However, the plugin gives an error message on my screen that cannot be copied/pasted. Hence I took a snapshot and attached the file to my post, as I was not sure how else to get the info posed here. And clicking on the atteched file makes it very readable. I tested that.
My apologies if posting it that way is cumbersome.

[Capricorn]

Originally Posted by Doitsu

Most likely, in the latest version of LT some of the command line parameters changed. I'll have a look at this and'll release updated versions of the plugins.

Thank you very much. Looking forward to the updated plugin.

[theducks]

Originally Posted by Capricorn

I tried to copy/paste the error message. However, the plugin gives an error message on my screen that cannot be copied/pasted. Hence I took a snapshot and attached the file to my post, as I was not sure how else to get the info posed here. And clicking on the atteched file makes it very readable. I tested that.
My apologies if posting it that way is cumbersome.

It has co copy to clipboard button, which seems to be a calibre standard?

[Capricorn]

Originally Posted by theducks

It has no copy to clipboard button, which seems to be a calibre standard?

No. Unfortunately not. No button, no nothing. Just what you see in the snapshot I attached. Just the error message.
But as the snapshot worked well (for me, at least)........................