nvaccess / nvda

NVDA, the free and open source Screen Reader for Microsoft Windows

https://www.nvaccess.org/

Other

2.12k stars 637 forks source link

User Guide: Document braille shorthands for controls such as dlg and tv #4130

Closed nvaccessAuto closed 9 years ago

nvaccessAuto commented 10 years ago

Reported by nvdakor on 2014-05-07 22:35 Hi, Just like other screen readers, NVDA provides braille shorthands for controls such as dialog (dlg), treeview (tv) and such. Although a seasoned braille user may be able to pick up easily, this may confuse new users who are getting started with screen reading software and braille in general. One suggestion posted on the NvDA list is to document braille shorthands for controls such as dlg for dialog in the user guide to help beginners learn different shorthands used by NVDA. Tahnks.

Blocking #4142

nvaccessAuto commented 10 years ago

Comment 1 by nvdakor on 2014-05-09 22:02 Hi, As for section placement, I propose placing this braille symbols list right after braille settings list in the user guide.

nvaccessAuto commented 10 years ago

Comment 2 by nvdakor on 2014-05-09 22:22 Initial work available for review:

URL: https://bitbucket.org/nvdaaddonteam/nvda
Branch: t4130
Commit ID: e3cfca3] For now, I have added a list of common abbreviations right after braille settings list in the user guide. Thanks.

nvaccessAuto commented 10 years ago

Comment 5 by Mesar Hameed <mesar.hameed@... on 2014-08-27 10:01 In [2a19ce9d2669f92b12e70326970ef4947693432b]:

Merge branch 't4130' into next. Incubates #4130
- t4130:
  UserGuide: Include braille controle type and state abbreviations.
  User Guide: added a list of common braille abbreviations used in NVDA (ticket 4130).

Changes: Added labels: incubating

nvaccessAuto commented 10 years ago

Comment 6 by jteh on 2014-08-27 12:33

This really doesn't belong in the Preferences section of the User Guide. It suggests we need a separate Braille section. Right now it's not going to contain very much, so it'll look a bit odd, but such is life.
I wonder whether we can trim the text for the roles. For example, we have "displayed in braille for an object which is a button". This could probably be shortened to just "button".

nvaccessAuto commented 10 years ago

Comment 7 by Mesar Hameed <mesar.hameed@... on 2014-08-27 18:50 In [49e58c74c6cb4bdcb13fa98c9430b283e47a6e4e]:

Merge branch 't4130' into next. Incubates #4130
- t4130:
  userGuide.t2t: braille control type and state indicators.

nvaccessAuto commented 10 years ago

Comment 8 by Mesar Hameed <mesar.hameed@... on 2014-09-05 10:02 In [b455161bc5492c2a15628938296b6055a587feb1]:

Merge branch 't4130' Fixes #4130
- t4130:
  userGuide.t2t: braille control type and state indicators.
  UserGuide: Include braille controle type and state abbreviations.
  User Guide: added a list of common braille abbreviations used in NVDA (ticket 4130).

Changes: Removed labels: incubating State: closed

nvaccessAuto commented 10 years ago

Comment 9 by jteh on 2014-09-06 00:19 For future reference, this should have waited at least 5 more days before merge to master. In this case, it isn't too important, since it's just a documentation change. However, the policy is that nothing should be merged to master until it has had no commits or complaints for at least 2 weeks. Thanks!

nvaccessAuto commented 10 years ago

Comment 10 by jteh on 2014-09-06 01:17 Changes: Milestone changed from None to 2014.4

nvaccessAuto commented 9 years ago

Comment 11 by surfer0627 on 2014-12-25 07:36 Hi, Confirmed the following abbreviations: || Abbreviation | Control state | | - | displayed when an object (e.g. a tree view item) is collapsible | | + | displayed when an object (e.g. a tree view item) is Expandable |

versus: source/braille.py

Translators: Displayed in braille when an object (e.g. a tree view item) is expanded.

controlTypes.STATEEXPANDED: ("-"),

Translators: Displayed in braille when an object (e.g. a tree view item) is collapsed.

controlTypes.STATECOLLAPSED: ("+"), Thanks.

nvaccessAuto commented 9 years ago

Comment 12 by jteh on 2015-01-06 03:59 They're just saying the same thing in different ways. Something that is expanded is by extension collapsable and vice versa. Are you just concerned that they're written differently or were you suggesting these meant something different?

nvaccessAuto commented 9 years ago

Comment 13 by surfer0627 (in reply to comment 12) on 2015-01-06 06:20 Replying to jteh: In user guide, the abbreviation plus (dot 3,4,6) mean an object (e.g. a tree view item) is Expandable. Actually, user read abbreviation dash (dot 3,6) displayed when an object is Expanded. Confirmed: which one is correct? Thanks.

nvaccessAuto commented 9 years ago

Comment 14 by jteh on 2015-01-06 06:31 You're confusing expandable with expanded. Expandable means the object can be expanded, meaning it's currently collapsed. So, expandable and collapsed mean the same thing here. In contrast, collapsable and expanded mean the same thing.

nvaccessAuto commented 9 years ago

Comment 15 by jteh on 2015-01-06 06:34 In other words, dash means the object is expanded (collapsable). Plus means the object is collapsed (expandable).

nvaccessAuto commented 9 years ago

Comment 16 by surfer0627 (in reply to comment 15) on 2015-01-06 06:57 Replying to jteh: Ok, thank you for the reply. Sorry, It's my fault. I misunderstand the meaning.