tdf#152589 Add Transtate command & settings Help page

+ Also add Help page for LanguageTool options + Note: DeepL service not available in Southern Hemisphere, therefore I've not tested it. Change-Id: I8a4bb01462e40113b40210b10024c59db0da293c Reviewed-on: https://gerrit.libreoffice.org/c/help/+/145366 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
author: Olivier Hallot <olivier.hallot@libreoffice.org> 2023-01-11 19:37:29 -0300
committer: Olivier Hallot <olivier.hallot@libreoffice.org> 2023-01-12 10:56:23 +0000
commit: f1c42932246dacd75345a130baee7fb6f07d9f07 (patch)
tree: 43db991b5cd7f13f9c2400519e8801f7044d7250
parent: 6b6ed464e1709685a0c20a7254d169c5553aa13a (diff)
7 files changed, 154 insertions, 11 deletions
diff --git a/AllLangHelp_shared.mk b/AllLangHelp_shared.mk
index 05ae40e093..b4bf2eadf7 100644
--- a/AllLangHelp_shared.mk
+++ b/AllLangHelp_shared.mk
@@ -865,6 +865,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,shared,\
     helpcontent2/source/text/shared/optionen/expertconfig \
     helpcontent2/source/text/shared/optionen/javaclasspath \
     helpcontent2/source/text/shared/optionen/javaparameters \
+    helpcontent2/source/text/shared/optionen/languagetools \
     helpcontent2/source/text/shared/optionen/macrosecurity \
     helpcontent2/source/text/shared/optionen/macrosecurity_sl \
     helpcontent2/source/text/shared/optionen/macrosecurity_ts \
@@ -874,6 +875,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,shared,\
     helpcontent2/source/text/shared/optionen/search_commands \
     helpcontent2/source/text/shared/optionen/serverauthentication \
     helpcontent2/source/text/shared/optionen/testaccount \
+    helpcontent2/source/text/shared/optionen/translatetools \
     helpcontent2/source/text/shared/optionen/viewcertificate \
     helpcontent2/source/text/shared/optionen/viewcertificate_c \
     helpcontent2/source/text/shared/optionen/viewcertificate_d \
diff --git a/AllLangHelp_swriter.mk b/AllLangHelp_swriter.mk
index f8539fa9ee..74ac2e11f2 100644
--- a/AllLangHelp_swriter.mk
+++ b/AllLangHelp_swriter.mk
@@ -175,6 +175,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,swriter,\
     helpcontent2/source/text/swriter/01/06210000 \
     helpcontent2/source/text/swriter/01/06220000 \
     helpcontent2/source/text/swriter/01/06990000 \
+    helpcontent2/source/text/swriter/01/contentcontrol00 \
     helpcontent2/source/text/swriter/01/edit_reference_submenu \
     helpcontent2/source/text/swriter/01/accessibility_check \
     helpcontent2/source/text/swriter/01/format_object \
@@ -206,8 +207,8 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,swriter,\
     helpcontent2/source/text/swriter/01/show_whitespace \
     helpcontent2/source/text/swriter/01/style_inspector \
     helpcontent2/source/text/swriter/01/title_page \
+    helpcontent2/source/text/swriter/01/translate \
     helpcontent2/source/text/swriter/01/watermark \
-    helpcontent2/source/text/swriter/01/contentcontrol00 \
     helpcontent2/source/text/swriter/02/02110000 \
     helpcontent2/source/text/swriter/02/03210000 \
     helpcontent2/source/text/swriter/02/03220000 \
diff --git a/source/text/shared/optionen/01150000.xhp b/source/text/shared/optionen/01150000.xhp
index fefd17e91a..1c519644a5 100644
--- a/source/text/shared/optionen/01150000.xhp
+++ b/source/text/shared/optionen/01150000.xhp
@@ -1,7 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-
-
 <!--
  * This file is part of the LibreOffice project.
  *
@@ -19,9 +16,7 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  -->
-
-
-		<helpdocument version="1.0">
+<helpdocument version="1.0">
 <meta>
 <topic id="textsharedoptionen01150000xml" indexer="include" status="PUBLISH">
 <title id="tit" xml-lang="en-US">Language Setting Options</title>
@@ -30,10 +25,9 @@
 </meta>
 <body>
 <bookmark xml-lang="en-US" branch="index" id="bm_id3148668"><bookmark_value>languages;setting options</bookmark_value>
-</bookmark><comment>mw changed index entry</comment><paragraph role="heading" id="hd_id3148668" xml-lang="en-US" level="1">Language Setting Options</paragraph>
-<paragraph role="paragraph" id="par_id3150499" xml-lang="en-US"><variable id="typotext">Defines the properties for additional languages. 
-</variable></paragraph>
-<paragraph role="note" id="par_id3153665" xml-lang="en-US">The <emph>Searching in Japanese</emph> and <emph>Asian Layout</emph> tab pages are only visible if the <emph>Asian language support</emph> option in the <emph>Languages</emph> tab page is activated and the <emph>Options</emph> dialog is re-opened. The <emph>Complex Text Layout</emph> tab page is only visible if the <emph>CTL support</emph> is enabled.</paragraph>
+</bookmark><comment>mw changed index entry</comment><h1 id="hd_id3148668">Language Setting Options</h1>
+<paragraph role="paragraph" id="par_id3150499" xml-lang="en-US"><variable id="typotext">Defines the properties for additional languages.</variable></paragraph>
+<note id="par_id3153665">The <emph>Searching in Japanese</emph> and <emph>Asian Layout</emph> tab pages are only visible if the <emph>Asian language support</emph> option in the <emph>Languages</emph> tab page is activated and the <emph>Options</emph> dialog is re-opened. The <emph>Complex Text Layout</emph> tab page is only visible if the <emph>CTL support</emph> is enabled.</note>
 <section id="howtoget">
   <embed href="text/shared/00/00000406.xhp#asiatypo"/>
 </section>
@@ -42,6 +36,8 @@
 <embed href="text/shared/optionen/01150200.xhp#japan"/>
 <embed href="text/shared/optionen/01150100.xhp#asialayout"/>
 <embed href="text/shared/optionen/01150300.xhp#ctl"/>
+<embed href="text/shared/optionen/languagetools.xhp#language_tools"/>
+<embed href="text/shared/optionen/translatetools.xhp#deeplserver"/>
 <embed href="text/shared/00/00000001.xhp#reset"/>
 </body>
 </helpdocument>
diff --git a/source/text/shared/optionen/languagetools.xhp b/source/text/shared/optionen/languagetools.xhp
new file mode 100644
index 0000000000..b264fe2f99
--- /dev/null
+++ b/source/text/shared/optionen/languagetools.xhp
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+    <!--
+    * This file is part of the LibreOffice project.
+    *
+    * This Source Code Form is subject to the terms of the Mozilla Public
+    * License, v. 2.0. If a copy of the MPL was not distributed with this
+    * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    *
+    -->
+<meta>
+    <topic id="textsharedoptionenlanguagetools.xhp" indexer="include" status="PUBLISH">
+    <title id="tit" xml-lang="en-US">Language Tools</title>
+    <filename>/text/shared/optionen/languagetools.xhp</filename>
+    </topic>
+</meta>
+<body>
+<bookmark id="bm_id441673455817771" xml-lang="en-US" branch="hid/cui/ui/langtoolconfigpage/OptLangToolPage" localize="false"/>
+<bookmark id="bm_id441673455818771" xml-lang="en-US" branch="hid/cui/ui/langtoolconfigpage/@@nowidget@@" localize="false"/>
+<bookmark xml-lang="en-US" branch="index" id="bm_id501673477245967">
+    <bookmark_value>LanguageTool;settings</bookmark_value>
+    <bookmark_value>writing aids;LanguageTool</bookmark_value>
+    <bookmark_value>spelling;LanguageTool</bookmark_value>
+    <bookmark_value>grammar;LanguageTool</bookmark_value>
+</bookmark>
+<section id="language_tools">
+    <h1 id="hd_id971673455817773"><variable id="h1"><link href="text/shared/optionen/languagetools.xhp">LanguageTool Server Options</link></variable></h1>
+    <paragraph id="par_id111673455817777" role="paragraph" xml-lang="en-US">Defines the properties for the LanguageTool server.</paragraph>
+</section>
+<section id="howtoget">
+    <paragraph role="paragraph" id="par_id801673456554456">Choose <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language Settings - LanguageTool Server</menuitem></paragraph>
+</section>
+<h2 id="hd_id211673459040344">LanguageTools API options</h2>
+<bookmark xml-lang="en-US" branch="hid/cui/ui/langtoolconfigpage/activate" id="bm_id741673459203722" localize="false"/>
+<h3 id="hd_id51673459045244">Enable LanguageTool</h3>
+<paragraph role="paragraph" id="par_id561673460402535">Check to enable the LanguageTool service.</paragraph>
+<h2 id="hd_id611673459049965">API Settings</h2>
+<bookmark xml-lang="en-US" branch="hid/cui/ui/langtoolconfigpage/baseurl" id="bm_id141673459244018" localize="false"/>
+<h3 id="hd_id931673459055757">Base URL</h3>
+<paragraph role="paragraph" id="par_id241673460445128">Enter the URL for the LanguageTool service, or use the default suggested.</paragraph>
+<bookmark xml-lang="en-US" branch="hid/cui/ui/langtoolconfigpage/username" id="bm_id181673459256265" localize="false"/>
+<h3 id="hd_id701673459061501">Username</h3>
+<paragraph role="paragraph" id="par_id421673460472461">Enter your username for the LanguageTool service.</paragraph>
+<bookmark xml-lang="en-US" branch="hid/cui/ui/langtoolconfigpage/apikey" id="bm_id311673459279418" localize="false"/>
+<h3 id="hd_id841673459066164">API Key</h3>
+<paragraph role="paragraph" id="par_id661673460487936">Enter your API key for the service.</paragraph>
+<section id="relatedtopics">
+    <paragraph role="paragraph" id="par_id161673477007259"><link href="https://languagetool.org/">LanguageTool home page</link></paragraph>
+</section>
+</body>
+</helpdocument>
diff --git a/source/text/shared/optionen/translatetools.xhp b/source/text/shared/optionen/translatetools.xhp
new file mode 100644
index 0000000000..cd7cf2d826
--- /dev/null
+++ b/source/text/shared/optionen/translatetools.xhp
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+    <!--
+    * This file is part of the LibreOffice project.
+    *
+    * This Source Code Form is subject to the terms of the Mozilla Public
+    * License, v. 2.0. If a copy of the MPL was not distributed with this
+    * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    *
+    -->
+<meta>
+    <topic id="textsharedoptionentranslatetools.xhp" indexer="include" status="PUBLISH">
+    <title id="tit" xml-lang="en-US">DeepL Server Options</title>
+    <filename>/text/shared/optionen/translatetools.xhp</filename>
+</topic>
+</meta>
+<body>
+<bookmark id="bm_id541673456768357" xml-lang="en-US" branch="hid/cui/ui/optdeeplpage/OptDeeplPage" localize="false"/>
+<bookmark id="bm_id541672456768357" xml-lang="en-US" branch="hid/cui/ui/optdeeplpage/@@nowidget@@" localize="false"/>
+<bookmark xml-lang="en-US" branch="index" id="bm_id261673477370062">
+    <bookmark_value>translation;automatic</bookmark_value>
+    <bookmark_value>translation;server settings</bookmark_value>
+    <bookmark_value>writing aids;translation</bookmark_value>
+</bookmark>
+<section id="deeplserver">
+    <h1 id="hd_id751673456768358"><variable id="h1"><link href="text/shared/optionen/translatetools.xhp">DeepL Server Options</link></variable></h1>
+    <paragraph id="par_id311673456768361" role="paragraph" xml-lang="en-US">Defines the properties for the DeepL server.</paragraph>
+</section>
+<paragraph role="paragraph" id="par_id991673458552159">DeepL Translator is a machine translation service that produces translations. DeepL Translator is available as a web-based service.</paragraph>
+<section id="howtoget">
+    <paragraph role="paragraph" id="par_id131673460329000">Choose <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language settings - DeepL Server</menuitem></paragraph>
+</section>
+<h2 id="hd_id721673457403254">DeepL API Options</h2>
+<bookmark xml-lang="en-US" branch="hid/cui/ui/optdeeplpage/apiurl" id="bm_id921673459669730" localize="false"/>
+<h3 id="hd_id581673457408904">API URL</h3>
+<paragraph role="paragraph" id="par_id631673458563165">Enter the URL of your DeepL server. Contact your DeepL provider to get this information.</paragraph>
+<bookmark xml-lang="en-US" branch="hid/cui/ui/optdeeplpage/authkey" id="bm_id701673459694394" localize="false"/>
+<h3 id="hd_id581673457416537">Authentication key</h3>
+<paragraph role="paragraph" id="par_id731673458569462">Enter your authentication key. Contact your service provider if necessary.</paragraph>
+<section id="relatedtopics">
+    <paragraph role="paragraph" id="par_id671673458674631"><link href="https://www.deepl.com">DeepL web service</link></paragraph>
+</section>
+</body>
+</helpdocument>
diff --git a/source/text/swriter/01/translate.xhp b/source/text/swriter/01/translate.xhp
new file mode 100644
index 0000000000..14926a1455
--- /dev/null
+++ b/source/text/swriter/01/translate.xhp
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+    <!--
+    * This file is part of the LibreOffice project.
+    *
+    * This Source Code Form is subject to the terms of the Mozilla Public
+    * License, v. 2.0. If a copy of the MPL was not distributed with this
+    * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    *
+    -->
+
+<meta>
+    <topic id="textswriter01translate.xhp" indexer="include" status="PUBLISH">
+    <title id="tit" xml-lang="en-US">Translate</title>
+    <filename>/text/swriter/01/translate.xhp</filename>
+    </topic>
+</meta>
+<body>
+<bookmark id="bm_id781673469995601" xml-lang="en-US" branch="hid/.uno:Translate" localize="false"/>
+<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/translationdialog/LanguageSelectDialog" id="bm_id271683471090428" localize="false"/>
+<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/translationdialog/@@nowidget@@" id="bm_id271673471090428" localize="false"/>
+<bookmark xml-lang="en-US" branch="index" id="bm_id891673478687650">
+    <bookmark_value>translate</bookmark_value>
+    <bookmark_value>language settings;translate</bookmark_value>
+</bookmark>
+<section id="translate">
+    <h1 id="hd_id811673469995601"><variable id="h1"><link href="text/swriter/01/translate.xhp">Translate</link></variable></h1>
+    <paragraph id="par_id931673469995604" role="paragraph" xml-lang="en-US">Translate the selected text or the whole document using DeepL automatic translation.</paragraph>
+</section>
+<section id="howtoget">
+    <paragraph role="paragraph" id="par_id691673470306954">Choose <menuitem>Tools - Translate</menuitem>.</paragraph>
+</section>
+<note id="par_id441673471361857">To enable the <emph>Translate</emph> command, set the server URL and API key in <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language Settings - DeepL Server</menuitem>.</note>
+<paragraph role="paragraph" id="par_id821673471828440">Translation works in two ways:</paragraph>
+<list type="unordered">
+    <listitem>
+        <paragraph id="par_id381673471870997"  role="listitem"><emph>Whole document</emph>: when there is no selection, the whole document is translated. Each paragraph is sent individually in order to minimize the  output timeout for each paragraph.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id621673471913182"  role="listitem"><emph>Selection</emph>: the selected contents is sent to the DeepL server for translation.</paragraph>
+    </listitem>
+</list>
+<section id="relatedtopics">
+    <paragraph role="paragraph" id="par_id671673458674631"><link href="https://www.deepl.com">DeepL web service</link></paragraph>
+    <paragraph role="paragraph" id="par_id391673475526676"><link href="text/shared/optionen/translatetools.xhp">Translate settings</link></paragraph>
+</section>
+</body>
+</helpdocument>
diff --git a/source/text/swriter/main0106.xhp b/source/text/swriter/main0106.xhp
index ebaca3d5c4..3296d8f531 100644
--- a/source/text/swriter/main0106.xhp
+++ b/source/text/swriter/main0106.xhp
@@ -39,6 +39,7 @@
   <embed href="text/shared/01/06010500.xhp#language"/>
   <embed href="text/swriter/01/06040000.xhp#wordcount"/>
   <embed href="text/swriter/01/accessibility_check.xhp#accessibilitycheckheading"/>
+  <embed href="text/swriter/01/translate.xhp#translate"/>
   <embed href="text/swriter/01/05150000.xhp#autoformat"/>
   <embed href="text/swriter/01/02120000.xhp#autotext"/>
author	Olivier Hallot <olivier.hallot@libreoffice.org>	2023-01-11 19:37:29 -0300
committer	Olivier Hallot <olivier.hallot@libreoffice.org>	2023-01-12 10:56:23 +0000
commit	f1c42932246dacd75345a130baee7fb6f07d9f07 (patch)
tree	43db991b5cd7f13f9c2400519e8801f7044d7250
parent	6b6ed464e1709685a0c20a7254d169c5553aa13a (diff)