From 6f6215475008caf9460574156f47e735c61999a8 Mon Sep 17 00:00:00 2001
From: Katja Marttila <katja.marttila@qt.io>
Date: Mon, 3 May 2021 16:32:05 +0300
Subject: Add documentation for translation usage

Task-number: QTIFW-2217
Change-Id: I15af0ac81842db386bb8d86b4a76bdd45722b4a9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
---
 doc/installerfw.qdoc | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

(limited to 'doc')

diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index e9a6463bc..c76576f27 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -525,9 +525,10 @@
             \li Filename for the configuration file on the target. Default is components.xml.
         \row
             \li Translations
-            \li List of language codes to be used for translating the user interface. To add several language
-                variants, specify several \c <Translation> child elements that each specify the name
-                of a language variant. Optional. For more information, see \l{Translating Pages}.
+            \li List of translation files to be used for translating the user interface. To add
+                several translation files, specify several \c <Translation> child elements that
+                each specify the name of the translation. Optional. For more information, see
+                \l{Translating Pages} and \l{Configuring and Overwriting Default Translations}.
         \row
             \li UrlQueryString
             \li This string needs to be in the form "key=value" and will be appended to archive download
@@ -721,6 +722,25 @@
     \note The translation system can also be used to customize the UI. Use e.g.
     an \c en.ts file to replace any text in the installer with a custom English
     version.
+
+    \section1 Configuring and Overwriting Default Translations
+
+    The installer has been localized into several languages. System language is used to define the
+    loaded language. In case you want to define the used language for your installer, define the
+    languages in \c config.xml using the \c <Translations> element. For example, using only German
+    translations:
+
+    \code
+        <Translations>
+            <Translation>ifw_de</Translation>
+            <Translation>qt_de</Translation>
+        </Translations>
+    \endcode
+
+    The default translations can be also overwritten. Write your own translation file and add
+    it to a custom resource called \c :/translations_new. This custom resource can be added to
+    the installer using \c binarycreator option \c -r. For more information, see
+    \l{Summary of binarycreator Parameters}.
 */
 
 /*!
-- 
cgit v1.2.3