Conversation
Qchristensen
left a comment
There was a problem hiding this comment.
All reads well, great work.
|
Also, in MathCAT doc, we have various such tables: There are exceptions but most of the time, an option was rather Enabled / Disabled, so that's what need to be put in the table, not Checked / Unchecked, which is only the state of the corresponding checkbox. Could we still change that? |
I'm not sure what you mean. Would you prefer these tables be written as | . {.hideHeaderRow} | . |
|---|---|
| Options | nabled, isabled |
| Default | Enabled |To the best of my knowledge, the MathCAT section is the only part of the user guide that actually has these checkboxes for tables, so I'm not sure there is precedent either way. Personally I think checked and unchecked make more sense for these tables, but I don't mind either way. |
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>
| @@ -1233,7 +1233,7 @@ | |||
| Below is a summary of the most useful commands for those wanting to quickly get started with navigating mathematical content. | |||
|
|
|||
| * Use the arrow keys to move left/right or up/down a mathematical structure (e.g. into/out of a fraction). | |||
There was a problem hiding this comment.
Should this say "in" a structure?
| * Use the arrow keys to move left/right or up/down a mathematical structure (e.g. into/out of a fraction). | |
| * Use the arrow keys to move left, right, up or down in a mathematical structure (e.g. into/out of a fraction). |
| * If inside a table, `control+arrow` keys will move by cell. | ||
| * `home` / `end` moves to the start/end of the expression. | ||
| * `space` reads your current position. | ||
| * `shift+upArrow` / `shift+downArrow` will change the mode of navigation, which will be discussed in more detail in the following section. |
There was a problem hiding this comment.
I'm not sure if we're trying to keep this section less formal for a reason. But if not:
| * If inside a table, `control+arrow` keys will move by cell. | |
| * `home` / `end` moves to the start/end of the expression. | |
| * `space` reads your current position. | |
| * `shift+upArrow` / `shift+downArrow` will change the mode of navigation, which will be discussed in more detail in the following section. | |
| * If inside a table, `Control+arrow` keys will move by cell. | |
| * `home` or `end` keys will move to the start or end of an expression, respectively. | |
| * `space` reads your current position. | |
| * `shift+upArrow` and `shift+downArrow` will change the mode of navigation, which will be discussed in the next section. |
I have left the keys lower cased, contrary to the Microsoft standard, since that's common in the UG.
Removed the "in more detail" from the last item, because it hasn't been discussed in any detail so far.
|
|
||
| MathCAT's navigation is the same in Microsoft Word and in a web browser. | ||
|
|
||
| While navigating an expression, `control+c` copies the math content of the current node in NVDA. |
There was a problem hiding this comment.
Could this line be clarified? The "in NVDA" here, reads strangely to me. Presumably it's the "node in NVDA", is it actually a virtualized node in NVDA, as the user understands it?
Would it be better to say "the current formula node" or some such, and leave off the "in NVDA"?
Not leaving a suggestion, because this sounds odd, but I'm not sure what's better. I'm not someone who works with formal math a lot.
There was a problem hiding this comment.
Yes, the concept of "node" has not been introduced anywhere previously and is not something meant to be known by end users.
Yes.
Yes, putting such tables in the UG is quite recent, especially for checkboxes, but there are at least 2 existing examples:
On the contrary, I think that enabled/disabled makes more sense. Not yet very sure why and I have no time these days to think deeper to this. But in a first thought, I'd say that Enabled/Disabled can be defined as soon as the option name is defined, what is always the case since the header of the section is the option's name. On the other hand, checked/unchecked can only exist as the state of a checkbox, so if we have explicitly mentioned such checkbox before. Are we sure we have mentioned a checkbox in all paragraph? |
|
@SaschaCowley, @seanbudd, @XLTechie's comments have been posted little time after this PR was merged, I imagine they have actually been written in parallel while you were merging. But they are valuable IMO and would have deserved a subsequent quick PR before beta11 and translation freeze. Also my comment mentioning the inconsistency regarding checkbox option tables between MathCAT and the rest of the User Guide (#19890 (comment)) had been posted one week before this PR was merged. True that me comment confirming this inconsistency with evidences has been posted the same day after the merge (#19890 (comment)) has been posted after the merge of this PR (the same day) since I had no access to a computer before. But it would have been easy to check yourself and / or to fix this inconsistency in a subsequent PR before the translation freeze. Would you still accept a PR with all these changes since we are at the very beginning of the freeze? Or better, do and review this PR yourself to go faster (because being at opposite sides of the earth, we often lose one ore more days when communicating together!) |
|
@CyrilleB79 I don't think any of the issues identified are sufficient to justify violating the string freeze. Feel free to open an issue/PR to fix the remaining issues in 2026.2 |
Link to issue number:
None
Summary of the issue:
The user guide and changelog for NVDA 2026.1 contain various typos, inconsistent capitalisation, broken anchors, incorrect key bindings, and minor wording issues that should be resolved before the translation freeze.
Description of user facing changes:
Description of developer facing changes:
None
Description of development approach:
Instructed Claude Code to review
user_docs/en/changes.mdanduser_docs/en/userGuide.md. Manually actioned its suggestions.Testing strategy:
Known issues with pull request:
None
Code Review Checklist: