From e208321a83df530d01670a478eafe958bbe57b13 Mon Sep 17 00:00:00 2001
From: Jonas Kalinka <jonas.kalinka@basyskom.com>
Date: Mon, 19 Feb 2024 12:59:05 +0100
Subject: [PATCH 1/3] add internationalization

---
 030_tool.internationalization.md | 43 ++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 030_tool.internationalization.md

diff --git a/030_tool.internationalization.md b/030_tool.internationalization.md
new file mode 100644
index 0000000..441a7ba
--- /dev/null
+++ b/030_tool.internationalization.md
@@ -0,0 +1,43 @@
+# Tool i18n: Make your software international
+
+## Goals
+Have translations delivered that are easy to integrate into the system to make your system speak the language of your customers. Build software that adapts to the country, language and timezone of the customers, without changing the code.
+
+## Description
+Since translations are often provided by a third party, it's important to consider the requirements of the project and have appropriate translation files delivered that are easy to integrate with Qt's translation system.
+
+## Environment
+Qt/QML
+
+## Platform
+All
+
+## Implementation effort
+Minimal/Medium (depending on how complex translations are handled)
+
+## Applicability
+Applicable whenever Qt is used as the UI framework
+
+## Caveats
+Clients might not want to use Qt's translation system and use a third party provider whose format is not compatible with Qt.
+
+Some projects require splitting translations over multiple files due to branding or other requirements. Those cases require a more complex handling of translation files being loaded by QTranslator.
+
+## See also
+\-
+
+## Implementation hints
+Qt provides a workflow using its .ts file format and Qt Linguist as a tool to specify, adapt and deploy translations.
+
+Decide which translation function to use, depending on the use case and project size:
+
+- by simple text → `qsTr()` (QML) / `QObject::tr()` (C++)
+- by text id → `qsTrId()` (QML)
+- by text and context → `qsTranslate()` (QML) / `QCoreApplication::translate()` (C++)
+
+Update translation files using `lupdate`, either via command line or directly from QtCreator: `Tools > External > Linguist > Update Translations` to update translation files (.ts) in your repository. These should be tracked by the version control system.
+
+Use [Qt Linguist](https://doc.qt.io/qt-5/qtlinguist-index.html) to provide translations for the user strings of your application.
+
+Build your translations using `lrelease`, either via command line or directly from QtCreator:
+`Tools > External > Linguist > Release Translations`. This will generate .qm files and should not be checked into the version control system but need to be deployed with your application.
\ No newline at end of file

From 65f93a10f72826d474cd6ad30a198726863ed819 Mon Sep 17 00:00:00 2001
From: Jonas Kalinka <jonas.kalinka@basyskom.com>
Date: Mon, 19 Feb 2024 13:06:14 +0100
Subject: [PATCH 2/3] added documentation link

---
 030_tool.internationalization.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/030_tool.internationalization.md b/030_tool.internationalization.md
index 441a7ba..ca8fb10 100644
--- a/030_tool.internationalization.md
+++ b/030_tool.internationalization.md
@@ -35,6 +35,8 @@ Decide which translation function to use, depending on the use case and project
 - by text id → `qsTrId()` (QML)
 - by text and context → `qsTranslate()` (QML) / `QCoreApplication::translate()` (C++)
 
+Refer to the "[Writing Source Code for Translation](https://doc.qt.io/qt-5/i18n-source-translation.html)" documentation for more advanced hints on how to write code for better translations.
+
 Update translation files using `lupdate`, either via command line or directly from QtCreator: `Tools > External > Linguist > Update Translations` to update translation files (.ts) in your repository. These should be tracked by the version control system.
 
 Use [Qt Linguist](https://doc.qt.io/qt-5/qtlinguist-index.html) to provide translations for the user strings of your application.

From 22d8bba7d0bc1a408c8e8a2d881f392abc125132 Mon Sep 17 00:00:00 2001
From: Jonas Kalinka <jonas.kalinka@basyskom.com>
Date: Mon, 19 Feb 2024 18:02:25 +0100
Subject: [PATCH 3/3] removed 'tool' from title

---
 030_tool.internationalization.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/030_tool.internationalization.md b/030_tool.internationalization.md
index ca8fb10..b347f31 100644
--- a/030_tool.internationalization.md
+++ b/030_tool.internationalization.md
@@ -1,4 +1,4 @@
-# Tool i18n: Make your software international
+# i18n: Make your software international
 
 ## Goals
 Have translations delivered that are easy to integrate into the system to make your system speak the language of your customers. Build software that adapts to the country, language and timezone of the customers, without changing the code.