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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Improve the messages in en-US #1033

Closed
wants to merge 1 commit into from
Closed

Improve the messages in en-US #1033

wants to merge 1 commit into from

Conversation

Poslovitch
Copy link
Member

@Poslovitch Poslovitch commented Nov 17, 2019 •
edited by tastybento

The goal of this PR is to ensure that:

  • All relevant sentences end with dots!
  • All the messages can be easily understood by non-native speakers, i.e. through the use of a simpler grammar with a more common vocabulary.
  • Color codes are standardized:
    • &a for "friendly" messages: the action succeeded, etc...
    • &c for "errors", critical messages or warnings: confirmations, etc...
    • &b should precede any "variables" or things we want the user to focus on: command suggestions, numbers, player names...
    • &e for descriptions.
    • Darker colors variants in case the brighter ones are not providing enough reading comfort (especially the brighter colors in GUIs' titles).
    • &7 for punctuation, mostly brackets (they help to pinpoint side information).
  • Messages targeting players should not mention any technical back-end details.
  • Messages targeting admins should provide precise explanations of the consequences of an action or solutions to a problem.
  • Multi-sentences messages are spread over multiple lines if it is appropriate.

I decided to do such a thing while I was translating some stuff on GitLocalize. If we want our translations to be of good quality, then we need to provide a high-quality baseline. We will also need to write down translation guidelines so that all addons live in the same boat 馃檪.

@tastybento: Since I'm not a native speaker, I'd really like you to check some of the changes I do, in order to make sure I'm not doing any silly mistakes.

I'm creating this PR as a draft for now since there's still plenty of room to improve.

@Poslovitch Poslovitch added Type: Enhancement Improvement or modification which is usually a new feature. Status: In progress Working on the issue. labels Nov 17, 2019
@Poslovitch Poslovitch added this to the 1.9.0 - SpigotMC release! milestone Nov 17, 2019
@tastybento tastybento self-requested a review November 17, 2019 23:45
@tastybento tastybento self-assigned this Nov 28, 2019
@tastybento
Copy link
Member

One other thing that really messes up machine translation on GitLocalize are the color codes. e.g.
"&cYou do not will often result in "you" not being translated and often the whole sentence is messed up. It's not an issue for manual translation, but I use machine translation to break the back of the wording and then go and fix it. We currently use ChatColor's color translation, but maybe if we added a space after the codes we could use our own. It's not that difficult to parse. What do you think?

@Poslovitch
Copy link
Member Author

I agree. Could you please file q feature request for that?

@Poslovitch
Copy link
Member Author

Postponing this to the next release.

@Poslovitch Poslovitch removed this from the 1.9.0 - SpigotMC release! milestone Dec 1, 2019
johncsuti
johncsuti reviewed Jan 31, 2020
View reviewed changes
src/main/resources/locales/en-US.yml
move-to-island: "&cMove to an island first!"
protecting: "&aPurge-protecting island"
unprotecting: "&aRemoving purge protection"
protecting: "&aProtecting this island from the purge."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Protecting this island from purges."

johncsuti
johncsuti reviewed Jan 31, 2020
View reviewed changes
src/main/resources/locales/en-US.yml
already-have-island: "&cYou already have an island!"
no-safe-location-found: "&cCould not find a safe spot to teleport you to on the island."
no-safe-location-found: "&cWe could not find a safe spot to teleport you to."
not-owner: "&cYou are not the owner of the island!"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be changes to "You are not the owner of this island."

johncsuti
johncsuti reviewed Jan 31, 2020
View reviewed changes
Copy link
Contributor

@johncsuti johncsuti left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check lines 24 and 90 for suggestions.
We should also remove all '!' and replace them with '.' Some people think using '!' means your yelling at the player.

@Poslovitch Poslovitch added this to the 1.11.1 milestone Feb 2, 2020
@Poslovitch Poslovitch removed this from the 1.11.1 milestone Feb 14, 2020
tastybento added a commit that referenced this pull request Dec 30, 2022
@tastybento
Edited US English text entries
0183380 
Supercedes #1033
@tastybento
Copy link
Member

Addressed by edits to US English files.

@tastybento tastybento closed this Dec 30, 2022
@tastybento tastybento deleted the review-en-US branch March 26, 2023 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johncsuti johncsuti johncsuti left review comments

@tastybento tastybento Awaiting requested review from tastybento

Assignees

@tastybento tastybento

Labels
Status: In progress Working on the issue. Type: Enhancement Improvement or modification which is usually a new feature.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Poslovitch @tastybento @johncsuti