Fix #5357: Remove CDATA from translatable strings. #5361
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
Also, add a regex check + test to ensure this doesn't regress in the future.
|
@adhiamboperes PTAL. |
|
(Preliminarily enabling auto-merge in case no issues are found since I might not be able to merge this before the next Translatewiki push). |
adhiamboperes
approved these changes
Mar 15, 2024
adhiamboperes
added a commit
that referenced
this pull request
May 22, 2024
BenHenning
added a commit
that referenced
this pull request
May 26, 2024
Reverts #5361 There are some formatting issues that cause incorrectness in the HTML structure, so @translatewiki cannot parse them correctly. This is the cause of empty translatiion strings in #5274. Mainly, some elements are missing their closing tags, e.g.: ```xml <string name="faq_answer_bug_reporting"><p><ol><li>From your %s app home screen, tap the menu in the top left corner.</li><li>Tap <strong>Share feedback</strong>.</li><li>Follow the instructions to report the bug or share feedback.</li></p></string> ``` is missing an \</ol\> tag before the closing \</p\> tag. I have looked at several of the other "broken" strings, and they have similar issues. When @translatewiki encounters an unclosed tag, it continues reading until it encounters a corresponding closing tag, in a subsequent string, meaning any strings between the two points are assumed to be part of a single string. This is obviously a serious bug in translatewiki itself. I think it is best to revert this PR and fix the issues first before merging it again. Co-authored-by: Ben Henning <[email protected]>
6 tasks
BenHenning
pushed a commit
that referenced
this pull request
Sep 10, 2024
<!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> ## Explanation Fixes #5357 This PR includes the changes previously included in #5361, with an additional fix for missing closing html tags described in #5403: ``` faq_answer_app_language: Missing </strong> tag after the email address. faq_answer_bug_reporting: Missing closing </ol> tag. faq_answer_exploration_player: Missing closing </ul> tag. faq_answer_update_app: Missing closing </ol> tag and closing </p> tag. faq_answer_update_os: Missing closing </ol> tag and closing </p> tag. ``` This PR removes all CDATA declarations in the translatable strings.xml file and instead escapes all necessary characters: < and > (& didn't need to be escaped since no strings use that character at the moment). This is needed because Translatewiki doesn't seem to extract the HTML within the CDATA declaration correctly, so it may not be translated (some existing strings were never translated, and per #5274 the latest FAQ changes aren't being processed correctly (leading to empty translation strings being submitted). This PR also introduces a regex check + test to ensure that CDATA isn't used anymore in strings. ## Essential Checklist <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".) - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). ## For UI-specific PRs only <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing
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.
Explanation
Fixes #5357
This PR removes all
CDATAdeclarations in the translatablestrings.xmlfile and instead escapes all necessary characters: < and > (& didn't need to be escaped since no strings use that character at the moment). This is needed because Translatewiki doesn't seem to extract the HTML within the CDATA declaration correctly, so it may not be translated (some existing strings were never translated, and per #5274 the latest FAQ changes aren't being processed correctly (leading to empty translation strings being submitted).This PR also introduces a regex check + test to ensure that CDATA isn't used anymore in strings.
Essential Checklist
For UI-specific PRs only
See video for a demonstration on all of the affected strings still rendering correctly (as far as I can tell) after this change:
demo_reduced.mp4