Add a dedicated translator guide document #1494
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
topic: documentation
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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
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:
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.
Change description
Creation of translator guide document
The contribution methods summary table can not effectively accommodate the additional content required to document all localization data sources so addition of a dedicated document is proposed for the purpose.
The use of a dedicated document for this information will also allow linking directly to that information from related documentation or conversations.
Add readme for localization data
Experience with maintenance of Arduino's localized projects indicates that the localization data files can appear to be the appropriate place to make edits for casual contributors not familiar with the project's sophisticated internationalization infrastructure.
Examples:
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. This file supplements the existing information about translation in the project's translation guide.
Other information
The rendered documents can be previewed here:
https://github.com/per1234/arduino-ide/blob/translation-guide/docs/contributor-guide/translation.md
https://github.com/per1234/arduino-ide/tree/translation-guide/i18n#readme
Reviewer checklist