From 0e8d5768b5253508e772e52cc4ef27711e140454 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sat, 24 Sep 2022 23:49:50 -0700 Subject: [PATCH 1/2] Add a dedicated translator guide document Translation of the strings of the Arduino IDE UI is a valuable contribution which helps to make Arduino accessible to everyone around the world. Localization of the Arduino-specific strings of the IDE is done in the "Arduino IDE 2.0" project on Transifex. Previously, the "Translation" row in the contribution methods summary table in the contributor guide entry page simply linked to that project. Arduino IDE also uses localized strings from several other sources: - VS Code language packs - Arduino CLI Users may notice unlocalized strings or errors or areas for improvement in the existing translations and wish to contribute translations. For this reason, it is important to also provide instructions for contributing to those other localization data sources. The contribution methods summary table can not effectively accommodate that additional content so a dedicated document is added for the purpose. This will also allow linking directly to that document from related documentation or conversations. --- docs/CONTRIBUTING.md | 4 ++-- docs/contributor-guide/translation.md | 33 +++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 docs/contributor-guide/translation.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 72e6a6e36..a1ca9e0c8 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -11,14 +11,14 @@ There are several ways you can get involved: | - Support
- Question
- Discussion | Post on the [**Arduino Forum**][forum] | | - Bug report
- Feature request | Issue report (see the guide [**here**][issues]) | | Testing | Beta testing, PR review (see the guide [**here**][beta-testing]) | -| Translation | [Transifex project][translate] | +| Translation | See the guide [**here**][translate] | | - Bug fix
- Enhancement | Pull request (see the guide [**here**][prs]) | | Monetary | - [Donate][donate]
- [Sponsor][sponsor]
- [Buy official products][store] | [forum]: https://forum.arduino.cc [issues]: contributor-guide/issues.md#issue-report-guide [beta-testing]: contributor-guide/beta-testing.md#beta-testing-guide -[translate]: https://www.transifex.com/arduino-1/ide2/dashboard/ +[translate]: contributor-guide/translation.md#translator-guide [prs]: contributor-guide/pull-requests.md#pull-request-guide [donate]: https://www.arduino.cc/en/donate/ [sponsor]: https://github.com/sponsors/arduino diff --git a/docs/contributor-guide/translation.md b/docs/contributor-guide/translation.md new file mode 100644 index 000000000..4b8b82400 --- /dev/null +++ b/docs/contributor-guide/translation.md @@ -0,0 +1,33 @@ +# Translator Guide + +The text of the Arduino IDE interface is translated into several languages. The language can be selected in the dialog opened via **File > Preferences** in the Arduino IDE menus (**Arduino IDE > Preferences** for macOS users). + +Translating text and improving on existing translations is a valuable contribution to the project, helping make Arduino accessible to everyone. + +The translations for the text found in the Arduino IDE come from several sources: + +## Arduino IDE Text + +Translations of Arduino IDE's text is done in the "**Arduino IDE 2.0**" project on the **Transifex** localization platform: + +https://explore.transifex.com/arduino-1/ide2/ + +## Base Application Text + +Arduino IDE leverages the localization data available for the [**VS Code**](https://code.visualstudio.com/) editor to localize shared UI text. This reduces the translation work required to add a new language to the text specific to the Arduino IDE project. + +For this reason, some of Arduino IDE's text is not found in the **Transifex** project. Suggestions for corrections or improvement to this text are made by submitting an issue to the `microsoft/vscode-loc` GitHub repository. + +Before submitting an issue, please check the existing issues to make sure it wasn't already reported:
+https://github.com/microsoft/vscode-loc/issues + +After that, submit an issue here:
+https://github.com/microsoft/vscode-loc/issues/new + +## Arduino CLI Text + +The [**Arduino CLI**](https://arduino.github.io/arduino-cli/latest/) tool handles non-GUI operations for the Arduino IDE. Some of the text printed in the "**Output**" panel and in notifications originates from **Arduino CLI**. + +Translations of Arduino CLI's text is done in the "**Arduino CLI**" Transifex project: + +https://explore.transifex.com/arduino-1/arduino-cli/ From 6d11243a9decc05f50b0a53ad7cf2df87aea7a4b Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 25 Sep 2022 00:02:00 -0700 Subject: [PATCH 2/2] Add readme for localization data Arduino IDE has been translated to several languages. The localization process follows the following steps: 1. An English language source string is defined in the Arduino IDE codebase 2. The source string is pushed to Transifex 3. Community translators localize the string 4. The localization data is pulled into the Arduino IDE repository 5. The localization data is incorporated into the Arduino IDE distribution Experience with maintenance of Arduino's localized projects indicates that the data files generated at step (4) can appear to be the appropriate place to make edits for casual contributors not familiar with the project's sophisticated internationalization infrastructure. Since those files are generated by automated systems, any edits made there would only be overwritten, so it is important to clearly communicate the correct way to make enhancements or corrections to these strings. This is accomplished by a local readme file most likely to be seen by those working in the folder containing these files, which supplements the existing information about translation in the project's translation guide. --- i18n/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 i18n/README.md diff --git a/i18n/README.md b/i18n/README.md new file mode 100644 index 000000000..b169b3dde --- /dev/null +++ b/i18n/README.md @@ -0,0 +1,11 @@ +# Localization Data + +This folder contains the [localization](https://en.wikipedia.org/wiki/Internationalization_and_localization) data for Arduino IDE. + +❗ These files are automatically generated and so can not be edited directly. If you wish to modify the contents, do it at the source: + +- **en.json** - edit the string in [the source code](../arduino-ide-extension/src) +- **All other files** - the localization is done on **Transifex**:
+ https://explore.transifex.com/arduino-1/ide2/ + +For more information on translating Arduino IDE, see [the **Translator Guide**](../docs/contributor-guide/translation.md).