Added Translation support (I18n) #240
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
Introduced an i18n system for localizing app text using key-value language files. Added `I18n.h` and `I18n.cpp` to manage translations, integrated i18n into welcome screens, and updated `MainHelper` to facilitate setup. Created a sample English language file (`i18n/en.txt`).
Updated the scripts to include wildcard file matching using `glob` for greater flexibility in file selection. Refactored and fixed formatting inconsistencies for improved readability. These changes streamline file embedding and copying processes in build workflows.
Introduced dynamic widget-specific translations and centralized language management in I18n. Added helper methods in WidgetSet for widget retrieval and improved iteration logic. This lays groundwork for better localization support and improves code consistency.
Move the I18N_DIR macro from MainHelper.h to I18n.h for better encapsulation and logical grouping of localization-related definitions. Also, remove an unnecessary include of MainHelper.h in I18n.cpp.
Removed redundant empty name check and clarified translation loading process in `WidgetSet`. Added localization entry for "Parqet" and improved robustness of `loadExtraTranslations` to handle empty suffixes.
Updated I18n system to handle a default language fallback when loading translations, ensuring robust behavior when specific language files are unavailable. Renamed parameters and improved clarity in translation loading logic for better maintainability.
Introduce language selection using a dropdown in the configuration settings, replacing hardcoded default handling. Added support for managing language IDs, retrieving available languages, and loading translations dynamically based on the selected language.
Adjusted the decrement logic in WidgetSet::prev() to prevent accessing invalid widget indices. Ensures proper wrapping behavior when navigating to the previous widget in the circular widget list.
Replaced hardcoded "Loading data:" text in WidgetSet with a translatable string using the i18n system. Added the "loading_data" key to English and German translation files to support localization. This improves maintainability and enables multi-language support.
Updated I18n to use `const char*` for translations to reduce memory usage and added proper cleanup via `clearTranslations()`. Implemented dynamic loading of widget-specific translations and updated ParqetWidget to leverage these changes. Adjusted related files and language resources accordingly.
…agement and usage constraints.
Replaced hardcoded strings with the newly implemented `i18n` function, centralizing translation handling and improving maintainability. Updated translation files (en/de) with additional keys for widget configuration options and labels. This ensures consistency and simplifies future localization efforts.
Updated i18n keys for consistency and improved translation handling. Added logging for missing and found translations in `I18n::get`. Simplified configuration translations using the `i18n` helper method for clarity and maintainability.
Standardize and localize configuration text by replacing raw strings with i18n keys in `ParqetWidget.cpp`. Added missing translations for new i18n keys in German and English localization files. Improved consistency and clarity in user-facing configuration labels.
|
I rebased this branch to the current The translations work, but there are some limitations with my current approach: On startup, I'm loading the translation string in a map<String, const char*>. I don't really like that (RAM is precious!), that's why I'd like to try a different approach before merging this PR: I'll try to put the translations in the source code instead of files on the LittleFS. This will probably allow us to store the translations in PROGMEM instead of RAM. But we lose the ability to download/edit/upload the translations without recompilation. |
flattermann
added
the
DO NOT MERGE
Replaced hardcoded strings with i18n keys across various modules to improve translations consistency and maintainability. Introduced dedicated translation files for better organization, including new headers in specific widgets like `ParqetWidget`. Optimized i18n function usage in configuration settings and removed outdated translation management logic.
Updated German translations to improve clarity and consistency. Simplified English rotation descriptions to remove redundant "clockwise" term. French translations remain unchanged.
Removed unused `getAllWidgets` and `getWidgetCount` methods from `WidgetSet`. Cleaned up redundant includes in `MainHelper.h` and adjusted related files for consistency. Minor update to use `DEFAULT_LANGUAGE` instead of a hardcoded value.
flattermann
removed
the
DO NOT MERGE
|
Ok, I switched to code based translations now. We have one file for general translations: See the two files above for examples. I've included translations for EN, DE, FR for some WebPortal config options (Sections "General", "TFT Settings" and "ParqetWidget"). FR definitely needs checking, because it's an automated translation. |
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.
Added support for translations via text files in
/i18n/.Each line in the translation files is a simple
key=valuepair.We parse the files in this order:
en.txt)de.txt), use the default language as fallbacken.widgetname.txt)de.widgetname.txt), use the default language as fallbackWe can use
I18n::get("key")to use the i18n strings.This also supports parameters, e.g.
I18n::get("version", "2.0").I would recommend for the widget specific files to use a prefix for each key, e.g.
parqet.name=Parqetto avoid name clashes.See also #238