Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG]: Format strings.xml(values-en) so that string tags are on one line #5164

Closed
adhiamboperes opened this issue Sep 30, 2023 · 0 comments · Fixed by #5166
Closed

[BUG]: Format strings.xml(values-en) so that string tags are on one line #5164

adhiamboperes opened this issue Sep 30, 2023 · 0 comments · Fixed by #5166
Assignees
Labels
bug End user-perceivable behaviors which are not desirable. good first issue This item is good for new contributors to make their pull request. Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Work: Low Solution is clear and broken into good-first-issue-sized chunks.

Comments

@adhiamboperes
Copy link
Collaborator

adhiamboperes commented Sep 30, 2023

Describe the bug

Because some strings are multiline, they are parsed with newlines on translatewiki which cascades down to the translated strings. This causes a problem with display.

Steps To Reproduce

See PRs #5161 and #5009 for details.

Expected Behavior

All strings opening and closing tags should be on a single line:
Correct:
<string name="text_input_default_hint_text">Tap here to enter text.</string>

Incorrect:

  <string name="ratio_default_hint_text" description="The default hint text for the ratio interaction if the placeholder text is not available.">
    Enter a ratio in the form x:y.
  </string>

For plurals, all item opening and closing tags should be on a single line:
Correct:

<plurals name="story_total_chapters">
    <item quantity="one">%s of %s Chapter Completed</item>
    <item quantity="other">%s of %s Chapters Completed</item>
  </plurals>

Incorrect:

<plurals name="chapter_count">
  <item quantity="one">
    1 Chapter
  </item>
  <item quantity="other">
    %s Chapters
  </item>
</plurals>
<plurals name="story_count">
  <item quantity="one">
    1 Story
  </item>
  <item quantity="other">
    %s Stories
  </item>
</plurals>

Additional Context

The linked PRs above highlight the problem strings, but a spot check is needed in strings.xml to make sure all the strings are formatted correctly.

@adhiamboperes adhiamboperes added Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). bug End user-perceivable behaviors which are not desirable. Work: Low Solution is clear and broken into good-first-issue-sized chunks. labels Sep 30, 2023
@adhiamboperes adhiamboperes added the good first issue This item is good for new contributors to make their pull request. label Sep 30, 2023
@Vishwajith-Shettigar Vishwajith-Shettigar self-assigned this Sep 30, 2023
adhiamboperes added a commit that referenced this issue Oct 1, 2023
…e line (#5166)

<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->
## Explanation
Fix #5164 , format the strings.xml(values-en).
Because some strings are multiline, they are parsed with newlines on
translatewiki which cascades down to the translated strings. This causes
a problem with display. So formatted them to single line
<!--
- Explain what your PR does. If this PR fixes an existing bug, please
include
- "Fixes #bugnum:" in the explanation so that GitHub can auto-close the
issue
  - when this PR is merged.
  -->

## 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))
- Add a screenshot demonstrating that you ran affected Espresso tests
locally & that they're passing

Co-authored-by: Adhiambo Peres <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug End user-perceivable behaviors which are not desirable. good first issue This item is good for new contributors to make their pull request. Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Work: Low Solution is clear and broken into good-first-issue-sized chunks.
2 participants