Skip to content

Reword some source translations #17703

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yafred
Copy link
Contributor

@yafred yafred commented Jun 16, 2025

First step of #17702

@yafred
Copy link
Contributor Author

yafred commented Jun 16, 2025

@superuser-does I found 2 keys in nvui. Please tell me if you see more in your logs. tks

@superuser-does
Copy link
Collaborator

superuser-does commented Jun 16, 2025

Thanks, some feedback and questions on this one first.

  1. I think the key names could be more expressive to match their text.
    e.g. moveToPieceByType2moveToSquaresUsingPieceNames
    and
    announcePieceLocations2announceLocationsOfPieces
  2. The text could be better improved further.
    In particular (if I understood it correctly!) "Move to squares using piece names. For example: repeated k will move to every square where there is a knight. Use uppercase to invert order."
    ... could perhaps be reworded as "Move to squares using piece names. For example, you can press k twice to move to any square where there is a knight." I believe giving the example in second person makes it easier to grasp.
    • I removed "Use uppercase to reverse the order". This sounds like a standard part of the interface that's should be part of an introduction instead of this specific string, but I could be wrong. It's not totally clear what 'reversing the order' means and it's not really an example so much as documentation. I understood it basically as 'move piece name to square'. This could be a separate example.
    • As a side note, I find it odd that "k" is used for knights - not just because of algebraic notation, but also because announcePieceLocations gives "N" for knights in its example
  3. I wonder if introducing quote marks (e.g. "k") or even a <kbd> element (e.g. k) would be beneficial when listening back . You can do the latter by including <kbd> as &lt;kbd&gt; in the string, which Scala will output as HTML.
    It may be useful to have these anyway for visual distinction, because many visually-impaired users can see a little bit, while still relying on a screen reader.
  4. I have been meaning to discuss this with you anyway, but I need clarity on whether letter names should be translateable, in case other languages use different notification. Could you use a Cyrillic letter in place of "R" for example, by changing the value in some other way for a different language? If not, then these letters should not be translateable, at least for now. You could do this by passing the letter in as a variable, so instead of "k", the translator would just have %s.

Beyond that - as far as NVUI strings are concerned, I'm comfortable that your other edits have not fundamentally changed the meaning of any strings (e.g. the "Command input form" was renamed 3 times, but still refers to the same thing). As such, there are no other rewordings required at this time.
There are older strings I have a list for, but those can be kept for another time.

I hope these initial thoughts help and would be grateful for your response on some of the points above. As noted, I don't fundamentally understand the user interactions and have not had the time to play this way, so if my suggestions are totally on the wrong track, please let me know. Even still, I reckon we could make these more user friendly, and couple up onboarding (i.e. a tutorial) with documentation for NVUI users.

@yafred
Copy link
Contributor Author

yafred commented Jun 16, 2025

  1. I agree

  2. I take your suggestion for the form. But for the content, you have to understand exactly what it does. As for k for knight, it's a typo ... it is n for knight (thanks for noticing it!)
    On the page there is an input field (to write moves and commands) and a board made out of 64 buttons.
    To discover the location of pieces, you can either use the input field or the board
    When you are on the board, you can also type one-letter commands
    If all the pieces are on the board, hitting 'n' repeatedly will move the focus to every button holding a knight (black or white).
    Shift 'n' will go backward.

  3. I am not sure what you mean ... the only way to make the best announcements is to use the screen reader and find out it needs help.
    For example: something I'd like to change position rendering a-2 instead of a2 (in the latter form, screen reader pronounce a as an article and not as a letter)
    As for visually impaired users, I must admit I did not consider them on the nvui. I thought they were using the visual interface with speech on. If you have more information about that, I am quite happy to hear them.
    At the moment, the users I am thinking of when I work on nvui are: blind users using the virtual keyboard (64 buttons) and blind users using an external tactile keyboard. They different needs.

  4. My position on non-English algebraic notation is this one:
    I have a translation i18n.nvui.sanSymbols to collect the letters that should be used if the user wanted to enter moves using a national algebraic notation. It's not implemented yet. It will be configurable because some users will want to hear the interface in their own language but type the move with English notation.
    I was planning to use it for input first (a French user would type Fc3 instead of Nc3 ... which could be helpful because the literal moves are now translated to Fou c3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants