Skip to content

Fixup Eurobraille docs#15194

Merged
seanbudd merged 2 commits into
betafrom
euroBrailleDocs
Jul 27, 2023
Merged

Fixup Eurobraille docs#15194
seanbudd merged 2 commits into
betafrom
euroBrailleDocs

Conversation

@seanbudd

@seanbudd seanbudd commented Jul 26, 2023

Copy link
Copy Markdown
Member

Link to issue number:

Follow up to #14690

Summary of the issue:

The docs for the eurobraille display aren't entirely clear and could use some rewording

Description of user facing changes

Fix up docs

Description of development approach

Fix up docs

Testing strategy:

N/a

Known issues with pull request:

n/a

Change log entries:

New features
Changes
Bug fixes
For Developers

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

@seanbudd seanbudd requested a review from a team as a code owner July 26, 2023 01:41
@seanbudd seanbudd requested review from CyrilleB79 and Qchristensen and removed request for a team July 26, 2023 01:41
@seanbudd

Copy link
Copy Markdown
Member Author

cc @FalkoBabbage - can you please review these changes?

@seanbudd seanbudd added this to the 2023.2 milestone Jul 26, 2023
@FalkoBabbage

Copy link
Copy Markdown
Contributor

I have passed this on to Eurobraille since they provided the documentation. I'll call them today as well.

@FalkoBabbage

Copy link
Copy Markdown
Contributor

Eurobraille agrees with the changes.
Below is the answer I got:

The changes are consistent with the documentation I sent you.

To add clarity to this documentation regarding key assignments we can add :


The Eurobraille driver is a generic driver for all its devices.

It is for this is why the driver key mapping refers keys L1 to L8 of Esytime.
For Esys and b.note these keys does not exists.
For b.book : L1 is backward key, L8 is forward key and L2 to L7 are the keys named C1 to C6.

For the same reason the driver key mapping refers Joystick1 and Joystick2 but on b.note these joysticks are 2 keypads of 4 keys.


I think a keyboard description for each braille devices is not necessary in NVDA documentation because users have a complete description in device documentation, but if it seems necessary to you or NVDA teams I can send you a short face description for each display ?

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All looks fine (with the note on capitalisation of braille)

Comment thread user_docs/en/userGuide.t2t Outdated
@seanbudd

Copy link
Copy Markdown
Member Author

Thanks @FalkoBabbage

Further information isn't necessary, but we would welcome any extra documentation which helps:

  • a user use the braille device with NVDA
  • a developer understand the braille driver and how it talks to the braille device

@seanbudd seanbudd merged commit c3a5340 into beta Jul 27, 2023
@seanbudd seanbudd deleted the euroBrailleDocs branch July 27, 2023 00:57
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.

3 participants