Internationalization of ZIM viewer #871
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
Codecov ReportBase: 72.01% // Head: 72.01% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #871 +/- ##
=======================================
Coverage 72.01% 72.01%
=======================================
Files 53 53
Lines 3745 3745
Branches 2093 2093
=======================================
Hits 2697 2697
Misses 1046 1046
Partials 2 2 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
veloman-yunkan
force-pushed
the
zim_viewer_i18n
branch
2 times, most recently
from
9f71990
to
952a1f9
Compare
|
Cleaned-up portion of #846 related to reusable frontend internationalization utilities and their application in the context of ZIM viewer is ready for review and final testing. |
mgautierfr
force-pushed
the
userlang_cookie_fixes
branch
from
f8bbed9
to
e35e758
Compare
veloman-yunkan
force-pushed
the
zim_viewer_i18n
branch
2 times, most recently
from
193beee
to
2af6974
Compare
mgautierfr
requested changes
Feb 2, 2023
This is a quick workaround (at the expense of data duplication) for having to generate the i18n data in JSON format from the embedded i18n resource data. Note, however, that at this point i18n resources are not included in the list of regular static resources. This will change in the next commit.
Did it by making the kiwix-compile-resources script take multiple arguments.
Before this change, some of the actions related to the initialization of the viewer were run in the global scope as a side effect of loading /skin/viewer.js. This change moves those actions into setupViewer().
mustache.js was obtained from the following location: - https://github.com/janl/mustache.js/raw/v4.2.0/mustache.js mustache.min.js which is a build artifact was taken from - https://cdnjs.cloudflare.com/ajax/libs/mustache.js/4.2.0/mustache.min.js Note that mustache.js is included in order to comply with Debian packaging requirements but will not be used in any other way (hence it is not added to resources_list.txt).
Serving the language list as a JS file rather than JSON simplifies a few things: - cacheid management; - having to manually delay the UI initialization until the JSON file is loaded. static/skin/languages.js must be generated/updated manually by running the static/generate_i18n_resources_list.py script.
ZIM viewer is now internally internationalized but the UI language
can only be set by providing the `userlang` query parameter in the URL:
Example:
/viewer?userlang=fr#wikipedia_en_climate_change_mini_2021-03/A/index
^^^^^^^^^^^^
Known issues - styling / placement - language changes via the selector UI are not recorded in the navigation history - changing the language via the UI doesn't update the `?userlang=` URL query parameter
Now that we have proper UI for user language selection, we don't need the `?userlang=` query parameter present in the URL. If `?userlang=` is explicitly provided in the URL, it sets the requested language and disappears.
veloman-yunkan
force-pushed
the
zim_viewer_i18n
branch
from
2af6974
to
a620c86
Compare
mgautierfr
approved these changes
Feb 6, 2023
|
This PR introduced another problem for the seamonkey browser caused by usage of |
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.
This PR has been extracted out of #846 so that changes related to ZIM viewer can be merged without waiting for resolution of the issues discovered while testing internationalization of the welcome page.
Depends on #869
In this PR I have eliminated the roundabout way of arriving at the final state of the internationalization utilities. Despite the title of this PR, it is mostly about introducing the infrastructure for frontend internationalization - ZIM viewer serves only as a small test range.