Better documentation of remote grammar checker settings

Signed-off-by: Andras Timar <andras.timar@collabora.com>
Change-Id: I0350cc2005325cec378a8942e3294ed18a66538a
pull/5829/head
Andras Timar 2023-02-06 10:40:04 +01:00 committed by Henry Castro
parent cdec13ce76
commit e4b056bfbf
1 changed files with 11 additions and 10 deletions

View File

@ -10,17 +10,18 @@
<allowed_languages desc="List of supported languages of Writing Aids (spell checker, grammar checker, thesaurus, hyphenation) on this instance. Allowing too many has negative effect on startup performance." default="de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru">@ALLOWED_LANGUAGES@</allowed_languages>
<!--
This is LanguageTool.org API settings. To turn it on, please set "enabled" property to true.
"base_url" may be https://api.languagetoolplus.com/v2 if the cloud version is used.
However, your data in the document e.g. the text part of it will be sent to the cloud API. Please read the privacy policy: https://languagetool.org/legal/privacy
These are the settings of external (remote) spellchecker and grammar checker services. Currently LanguageTool and Duden are supported, you can set either of them.
By default they are disabled. To turn the support on, please set "enabled" property to true. It works with self hosted or cloud services, free and premium as well.
The "base_url" may be https://api.languagetoolplus.com/v2 if the cloud version is used. Please note that your data in the document e.g. the text part of it will be
sent to the cloud API. Please read the respective privacy policies, e.g. https://languagetool.org/legal/privacy or https://www.duden.de/service/datenschutz.
-->
<languagetool desc="LanguageTool Remote API settings for grammar checking">
<enabled desc="Enable LanguageTool Remote Grammar Checker" type="bool" default="false"></enabled>
<base_url desc="Http endpoint for the LanguageTool API server, without /check or /languages postfix at the end." type="string" default=""></base_url>
<user_name desc="LanguageTool account username for premium usage." type="string" default=""></user_name>
<api_key desc="Api key provided by LanguageTool account for premium usage." type="string" default=""></api_key>
<ssl_verification desc="Enable or disable SSL verification" type="string" default="true"></ssl_verification>
<rest_protocol desc="REST API protocol used by LanguageTool" type="string" default=""></rest_protocol>
<languagetool desc="Remote API settings for spell and grammar checking">
<enabled desc="Enable Remote Spell and Grammar Checker" type="bool" default="false"></enabled>
<base_url desc="HTTP endpoint for the API server, without /check or /languages postfix at the end." type="string" default=""></base_url>
<user_name desc="LanguageTool or Duden account username for premium usage." type="string" default=""></user_name>
<api_key desc="API key provided by LanguageTool or Duden account for premium usage." type="string" default=""></api_key>
<ssl_verification desc="Enable or disable SSL verification. You may have to disable it in test environments with self-signed certificates." type="string" default="true"></ssl_verification>
<rest_protocol desc="REST API protocol. For LanguageTool leave it blank, for Duden use the string 'duden'." type="string" default=""></rest_protocol>
</languagetool>
<deepl desc="DeepL API settings for translation service">