Localization notes and tips

[BlakeNeko]

When I'm using Sandboxie-plus, I noticed some zh-CN translation is missing or can be improved.
I tried walk through the source code and found the translation files but don't know how to get start.
Since I don't have any experience how to add/modify translations while using github or other tools, it's Is there any methods I can help to fix them?
(Not a native English speaker, sorry if I made some grammar mistakes)

[isaak654]

How to locate translations in the Sandboxie repository

1. Here you can find the location of the Sandboxie Plus translation files in the repository (sandman_*.ts)
2. Here you can find the location of the Sandboxie Plus installer translation file (recommended if you have already translated Plus interface)
3. Here you can find the location of the Sandboxie Plus installer script with the language value to add (recommended if you have already translated Plus interface)
4. Here you can find the location of the Sandboxie Plus translation files for the troubleshooting wizard (lang_*.json)
5. Here you can find the location of the Sandboxie Classic translation files (Sbie-English-1033.txt, Text-*-*.txt)
6. Here you can find the location of the Sandboxie Classic installer script (in case you have to provide a missing language)

Please consider to create new pull requests periodically if you have new language updates to merge. For this task, I would recommend to use GitHub desktop because it helps to manage a lot of strings. Github Desktop for Linux-based systems is not officially supported, but there is an available fork.

Qt Linguist to update Plus translations

The official translation tool for Sandboxie Plus is Qt Linguist, which usually requires the installation of the Qt online installer (online course: here). At the end of the process, you will be able to run the following command lines that I found useful to sync and translate the missing strings:

C:\Qt\6.1.1\msvc2019_64\bin\lupdate.exe SandMan.pri at \SandboxiePlus\SandMan (shared by yfdyh000)
or
C:\Qt\6.1.1\msvc2019_64\bin\lupdate-pro.exe SandboxiePlus.pro at \SandboxiePlus.

You need to make a local clone of the repository first (for example with the Github Desktop tool mentioned before), then running one of the commands above from the path where SandMan.pri or SandboxiePlus.pro is located (it depends on the command you have chosen). In this way, you'll get the new changes in GitHub Desktop (or in any Git client you're using). At this point, you can use a translation tool like Qt Linguist to update the translation.

At the beginning of the output, you may receive a number of Cannot run compiler 'cl' , but all current .ts files will be still updated.

Using Qt Creator to synchronize Sandboxie Plus translations

In order to set up the sync on the Qt Creator tool, select the menu Tools -> External -> Configure -> Environment -> External Tools -> Update Translations (lupdate). For more information, see also Using External Tools.

In my configuration, the executable is set to C:\Qt\5.15.2\msvc2019_64\bin\lupdate-pro.exe, the Arguments line needs to contain just SandboxiePlus.pro and the working directory needs the full path which contains SandboxiePlus.pro and all other repository folders.
After doing that, if everything is correct, just run Update Translations (lupdate) from Tools menu -> External -> Linguist

⚠️ Note: if the executable is found in your system PATH variable, do not specify the path to it.

Set the target language and country for Plus translations

Once your `sandman_xx.ts` file is open in `Qt Linguist`, you can customize the locale information from the Edit menu -> Translation File Settings -> set one of the values in the Target language category -> save the .ts file from the File menu. For more information, see also Changing the Target Locale.

Recommendations for all translators in this repository

⚠️ You shouldn't ever edit the text inside the source tags of the .ts file(s) before applying the same change on the respective source code file(s). For example, in commit 3b86441 I edited the source file and all the .ts files together. In your case, you could just update your specific .ts file together with the source file(s) in question and nothing else.

⚠️ As a rule of thumb, you shouldn't ever translate the .ts file(s) by hand, in order to avoid formatting issues (the use of an official translation tool like Qt Linguist is highly recommended).

⚠️ It's not useful to reintroduce the translated entries tagged as vanished, because they're outdated. It's recommended to keep them as they are for a limited time as reference, in order to avoid future clutter. A similar recommendation could be applied for the oldsource tags.

📑 There is a new scheduled job to synchronise the language entries that are updated or added in new Sandboxie releases. See A new workflow to improve delivery of language updates for a quick explanation of how it works.

📑 Once the source files for Sandboxie Plus are updated, the lupdate workflow takes care of updating all .ts files regularly through a schedule, for example: d11000f.

📑 Sandboxie Classic translation files are also used in specific Plus options, so it's advisable to look at the reports here to track the new entries.

Further translation tips

1. Steps to install/set Qt:
   Updating translations on Sandboxie Plus - how to? #885 (comment)
2. How to use Qt Linguist to prevent formatting issues:
   Add Korean translation (Sandboxie Plus) #2133 (review)
3. How to test the translation locally in Sandboxie Plus:
   Offering help to translate to spanish latam #593 (comment)
4. AutoIt3 script that gets the Sandboxie Classic strings for the Plus Installer custom messages in Languages.iss:
   Update Dutch translations 2021-12-22 #1455 (comment)

Building Qt 5 sources (for developers)

https://wiki.qt.io/Building_Qt_5_from_Git
https://doc.qt.io/qt-5/linux-building.html
https://www.linuxfromscratch.org/blfs/view/svn/x/qt5.html
https://stackoverflow.com/q/14571701
https://stackoverflow.com/q/14170590

[sebadamus]

Newbie question... just to be sure... I do have to download the project locally to do the sync stuff, right?
I mean... C:\Qt\6.1.1\msvc2019_64\bin\lupdate.exe SandMan.pri?

Thanks,

PS: just got the QT complete running with wine, and the lupdate.exe found! (I had previously downloaded just QT-Linguist and hasnt the lupdate.exe

[isaak654]

You need to make a local clone of the repository first, then running the command from the path where SandMan.pri is located. In this way, you'll get the new changes in GitHub Desktop (or any Git client you're using). At this point, you can use Qt Linguist to update the translation.

[sebadamus]

Thanks, just could lupdate my sandman_es.ts there are about 20 extra stuff to translate, will do soon!

[Zerorigin]

This is my use case. I hope it will be helpful for others.

# fork & clone the repo
pushd R:/
git clone --depth 1 [email protected]:[your_username]/Sandboxie.git

# Download [Qt Linguist Standalone](https://github.com/lelegard/qtlinguist-installers/releases), it's sufficien for the job.
# sync & lupdate single ts file example
pushd R:\Sandboxie\SandboxiePlus\SandMan
D:\Devs\QtLinguist\lupdate.exe . -ts sandman_zh_CN.ts
D:\Devs\QtLinguist\linguist.exe .\sandman_zh_CN.ts
　

[Zerorigin]

It's easy to create a workflow, but some translators want to keep special formatted of source lines at .ts file, which is a trouble.

[isaak654]

See https://stackoverflow.com/a/34903961

It's part of the XML language definition. Since ' is a special character in xml, it has to be escaped. Otherwise, a XML parser will not be able to read the file. In other words ' is nothing but an escape sequence for ' and any XML reader will replace ' with ' while reading the xml file.

The escape sequences are:

"   "
'   '
<   &lt;
>   &gt;
&   &amp;

Any .ts file starts with <?xml version="1.0" encoding="utf-8"?>