-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Docs: Accessibility: Document how to use the app with a screen reader #11897
base: dev
Are you sure you want to change the base?
Docs: Accessibility: Document how to use the app with a screen reader #11897
Conversation
readme/apps/keyboard_interface.md
Outdated
3. **Editable**: A note editor. | ||
4. **Frame**: A note viewer. | ||
|
||
Many screen readers include shortcuts for jumping to the next/previous of each of these roles. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may make sense to link to documentation for some of the popular screen readers. For example, Orca's structural navigation and NVDA's single-letter navigation (Thanks @cary-rowen for the link!).
|
||
By default, pressing <kbd>tab</kbd> indents, rather than moves focus. This can be changed by toggling "Tab moves focus" from the "View" menu. By default, this can also be toggled by pressing <kbd>ctrl</kbd>-<kbd>m</kbd>. | ||
|
||
## Navigating the mobile app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section needs more information. Here are a few things it could include:
- How to select notes (then duplicate/move/delete them) using a screen reader.
- How to edit a notebook's title/location using a screen reader.
- How to toggle to-dos.
- Links to documentation for customizing the toolbar.
- Links to voice typing documentation (Android).
- Link to audio recording documentation (this may need to be created).
- Perhaps also discuss known accessibility issues (though better would be to fix these :) ).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think giving an overview for now may be good enough? Then the document can be completed over time based on user feedback. The drawback of having a lot of information is that it may become stale and would have to be updated.
@@ -0,0 +1,48 @@ | |||
# Keyboard interface |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps instead, this should be:
# Keyboard interface | |
# Screen reader accessibility |
or
# Keyboard interface | |
# Screen reader support |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes I guess we could focus the document on accessibility, so your second title would make sense. In that case the file should be renamed too
Hi, It is always useful to write a document for screen reader users. Thanks, |
Summary
This work-in-progress pull request adds basic documentation for using the application with a screen reader (or with only a keyboard).
Feedback on what to include would be welcome!