/
userGuide.t2t
2256 lines (1836 loc) · 138 KB
/
userGuide.t2t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
NVDA NVDA_VERSION User Guide
%!includeconf: ../userGuide.t2tconf
%kc:title: NVDA NVDA_VERSION Commands Quick Reference
= Table of Contents =[toc]
%%toc
+ Introduction +
NonVisual Desktop Access (NVDA) is a free and open source screen reader for the Microsoft Windows operating system.
Providing feedback via synthetic speech and Braille, it enables blind or vision impaired people to access computers running Windows for no more cost than a sighted person.
NVDA is developed by [NV Access http://www.nvaccess.org/], with contributions from the community.
++ General Features ++
NVDA allows blind and vision impaired people to access and interact with the Windows operating system and many third party applications.
Major highlights include:
- Support for popular applications including web browsers, email clients, internet chat programs and office suites
- Built-in speech synthesizer supporting over 80 languages
- reporting of textual formatting where available such as font name and size, style and spelling errors
- Automatic announcement of text under the mouse and optional audible indication of the mouse position
- Support for many refreshable braille displays, including input of computer braille for braille displays which have a braille keyboard
- Ability to run entirely from a USB stick or other portable media without the need for installation
- Easy to use talking installer
- Translated into 47 languages
- Support for modern Windows Operating Systems including both 32 and 64 bit variants
- Ability to run on Windows logon and other secure screens
- Support for common accessibility interfaces such as Microsoft Active Accessibility, Java Access Bridge, IAccessible2 and UI Automation (UI Automation only supported in Windows 7 and later)
- support for Windows Command Prompt and console applications
-
++ Internationalization ++
It is important that people anywhere in the world, no matter what language they speak, get equal access to technology.
Besides English, NVDA has been translated into 47 languages including: Afrikaans, Albanian, Amharic, Arabic, Aragonese, Brazilian Portuguese, Bulgarian, Catalan, Colombian Spanish, Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, Galician, Greek, Georgian, German, Hebrew, Hindi, Hungarian, Icelandic, Irish, Italian, Japanese, Korean, Nepali, Norwegian, Polish, Portuguese, Punjabi, Romanian, Russian, Serbian, Slovak, Slovenian, Spanish, Swedish, Tamil, Thai, Traditional and Simplified Chinese, Turkish, Ukrainian and Vietnamese.
++ Speech Synthesizer Support ++
Apart from providing its messages and interface in several languages, NVDA can also enable the user to read content in any language, as long as they have a speech synthesizer that can speak that language.
NVDA is bundled with [eSpeak NG https://github.com/espeak-ng/espeak-ng], a free, open-source, multi-lingual speech synthesizer.
Information about other speech synthesizers that NVDA supports can be found in the [Supported Speech Synthesizers #SupportedSpeechSynths] section.
++ Braille support ++
For users that own a refreshable braille display, NVDA can output its information in Braille.
Please see the [Supported Braille Displays #SupportedBrailleDisplays] section for information about the supported braille displays.
NVDA supports braille codes for many languages, including contracted, uncontracted and computer braille codes for many languages.
++ Licence and Copyright ++
NVDA is copyright NVDA_COPYRIGHT_YEARS NVDA contributors.
NVDA is covered by the GNU General Public License (Version 2).
You are free to share or change this software in any way you like as long as it is accompanied by the license and you make all source code available to anyone who wants it.
This applies to both original and modified copies of this software, plus any derivative works.
For further details, you can [view the full licence. http://www.gnu.org/licenses/old-licenses/gpl-2.0.html]
+ System Requirements +
- Operating Systems: all 32-bit and 64-bit editions of Windows XP, Windows Vista, Windows 7, Windows 8, Windows 8.1 and Windows 10 (including Server operating Systems)
- For Windows XP 32-bit, NVDA requires Service Pack 2 or higher.
- For Windows Server 2003, NVDA requires Service Pack 1 or higher.
- For Windows Vista, NVDA requires Service Pack 2 and the [KB2763674 https://support.microsoft.com/en-us/kb/2763674] update.
Both of these should be installed if all available updates are applied via Windows Update.
- Memory: 256 mb or more of RAM
- Processor speed: 1.0 ghz or above
- About 90 MB of storage space.
-
+ Getting and Setting Up NVDA +
If you have not yet got a copy of NVDA, you can download it from [www.nvaccess.org NVDA_URL].
Go to the download section and you will find a link to download the latest version of NVDA.
Running the file you have just downloaded will start a temporary copy of NVDA.
You will then be asked if you want to install NVDA, create a portable copy or just continue using the temporary copy.
If you plan to always use NVDA on this computer, you will want to choose to install NVDA.
Installing NVDA will allow for additional functionality such as automatic starting after logon, the ability to read the Windows Logon and Windows security screens (which cannot be done with portable and temporary copies) and creation of Start Menu and desktop shortcuts.
The installed copy is also able to create a portable copy itself at any time.
If you want to take NVDA with you on a USB thum drive or other writable media, then you should choose to create a portable copy.
The portable copy also has the ability to install itself on any computer at a later time.
However, if you wish to copy NVDA onto read-only media such as a CD, you should just copy the download package.
Running the portable version directly from read-only media is not supported at this time.
Using the temporary copy of NVDA is also an option (e.g. for demonstration purposes), though starting NVDA in this way each time can become very time consuming.
++ Portable and Temporary Copy Restrictions ++
Apart from the inability to automatically start during and/or after log-on, the portable and temporary copies of NVDA also have the following restrictions:
- The inability to interact with applications running with administrative privileges, unless of course NVDA itself has been run also with these privileges (not recommended).
- The inability to read User Account Control (UAC) screens when trying to start an application with administrative privileges.
- Windows 8 and later: the inability to support input from a touch screen.
- Windows 8 and later: the inability to provide features such as browse mode and speaking of typed characters in Windows Store apps.
-
++ Installing NVDA ++
If installing NVDA directly from the NVDA download package, press the Install NVDA button.
If you have already closed this dialog or are wanting to install from a portable copy, please choose the Install NVDA menu item found under Tools in the NVDA menu.
The installation dialog that appears will confirm whether you wish to install NVDA and will also tell you whether this installation will be updating a previous install.
Pressing the Continue button will start installing NVDA.
There are also a few options in this dialog which are explained below.
Once the installation has completed, a message will appear telling you that it was successful.
Pressing OK at this point will restart the newly installed copy of NVDA.
+++ Start at Windows Logon +++
This option allows you to choose whether or not NVDA should automatically start while on the Windows Logon screen, before you have entered a password.
This also includes UAC control and other secure screens.
+++ Create Desktop Shortcut (ctrl+alt+n) +++
This option allows you to choose whether or not NVDA should create a shortcut on the desktop to start NVDA.
If created, this shortcut will also be assigned a shortcut key of control+alt+n, allowing you to start NVDA at any time with this key stroke.
+++ Copy Portable Configuration to Current User Account +++
This option allows you to choose whether or not NVDA should copy the user configuration from the currently running NVDA into the configuration for the currently logged on user, for the installed copy of NVDA.
This will not copy the configuration for any other users of this system nor to the system configuration for use at Windows Logon and other secure screens.
This option is only available when installing from a portable copy, not when installing directly from the downloaded Launcher package.
++ Creating a Portable Copy ++
If creating a portable copy directly from the NVDA download package, simply press the Create Portable Copy button.
If you have already closed this dialog or you are running an installed copy of NVDA, choose the Create Portable copy menu item found under Tools in the NVDA menu.
The Dialog that appears allows you to choose where the portable copy should be created.
This can be a directory on your hard drive or a location on a USB thum drive or other portable media.
There is also an option to choose whether NVDA should copy the logged on user's current NVDA configuration for use with the newly created portable copy.
This option is only available when creating a portable copy from an installed copy, not when creating from the download package.
Pressing Continue will create the portable copy.
Once creation is complete, a message will appear telling you it was successfull.
Press OK to dismiss this dialog.
+ Getting started with NVDA +
++ Launching NVDA ++
If you have installed NVDA with the installer, then starting NVDA is as simple as either pressing control+alt+n, or choosing NVDA from the NVDA menu under Programs on the Start Menu.
Additionally you can type NVDA into the Run dialog and press Enter.
You can also pass some [command line options #CommandLineOptions] which allows you to restart NVDA (-r), quit (-q), disable add-ons (--disable-addons), etc.
To start the portable version, go to the directory you unpacked NVDA to, and press enter or double click on nvda.exe.
As NVDA starts, you will first hear an ascending set of tones (telling you that NVDA is loading).
Depending on how fast your computer is, or if you are running NVDA off a USB key or other slower medium, it may take a little while to start.
If it is taking an extra long time, NVDA should say "Loading NVDA. Please wait..."
If you don't hear any of this, or you hear the Windows error sound, or a descending set of tones, then this means that NVDA has an error, and you will need to possibly report a bug to the developers.
Please check out the NVDA website for how to do this.
When NVDA starts for the first time, you will be greeted by a dialog box which provides you with some basic information about the NVDA modifier key and the NVDA menu.
(Please see further sections about these topics.)
The dialog box also contains three checkboxes.
The first lets you control if NVDA should use the capslock as an NVDA modifier key.
The second specifies whether NVDA should start automatically after you log on to Windows and is only available for installed copies of NVDA.
The third lets you control if this Welcome dialog should appear each time NVDA starts.
++ About NVDA keyboard commands ++
+++ The NVDA Modifier Key +++
Most NVDA-specific keyboard commands consist of pressing a particular key called the NVDA modifier key in conjunction with one or more other keys.
Notable exceptions to this are the text review commands for the desktop keyboard layout which just use the numpad keys by themselves, but there are some other exceptions as well.
NVDA can be configured so that the numpad Insert, Extended Insert and/or capslock key can be used as the NVDA modifier key.
By default, both the numpad Insert and Extended Insert keys are set as NVDA modifier keys.
If you wish to cause one of the NVDA modifier keys to behave as it usually would if NVDA were not running (e.g. you wish to turn capslock on when you have set capslock to be an NVDA modifier key), you can press the key twice in quick succession.
+++ Keyboard Layouts +++
NVDA currently comes with two sets of key commands (known as keyboard layouts): the desktop layout and the laptop layout.
By default, NVDA is set to use the Desktop layout, though you can switch to the Laptop layout in the Keyboard Settings, found under Preferences in the NVDA menu.
The Desktop layout makes heavy use of the numpad (with numlock off).
Although most laptops do not have a physical numpad, some laptops can emulate one by holding down the FN key and pressing letters and numbers on the right-hand side of the keyboard (7, 8, 9, u, i, o, j, k, l, etc.).
If your laptop cannot do this or does not allow you to turn numlock off, you may want to switch to the Laptop layout instead.
++ NVDA Touch Gestures ++
If you are running NVDA on a device with a touch screen and running Windows 8 or higher, you can also control NVDA directly via the touch screen.
While NVDA is running, all touch input will go directly to NVDA.
Therefore, actions that can be performed normally without NVDA will not work.
+++ Exploring the Screen +++
The most basic action you can perform with the touch screen is to announce the control or text at any point on the screen.
To do this, place one finger anywhere on the screen.
You can also keep your finger on the screen and move it around to read other controls and text that your finger moves over.
+++ Touch Gestures +++
When NVDA commands are described later in this user guide, they may list a touch gesture which can be used to activate that command with the touch screen.
Following are some instructions on how to perform the various touch gestures.
==== Taps ====
Tap the screen quickly with one or more fingers.
Tapping once with one finger is simpley known as a tap.
Tapping with 2 fingers at the same time is a 2-finger tap and so on.
If the same tap is performed one or more times again in quick succession, NVDA will instead treat this as a multi-tap gesture.
Tapping twice will result in a double tap.
Tapping 3 times will result in a triple tap and so on.
Of course, these multi-tap gestures also recognize how many fingers were used, so it's possible to have gestures like a 2-finger triple tap, a 4-finger tap, etc.
==== Flicks ====
Quickly swipe your finger across the screen.
There are 4 possible flick gestures depending on the direction: flick left, flick right, flick up and flick down.
Just like taps, more than one finger can be used to perform the gesture.
Therefore, gestures such as 2-finger flick up and 4-finger flick left are all possible.
+++ Touch Modes +++
As there are many more NVDA commands than possible touch gestures, NVDA has several touch modes you can switch between which make certain subsets of commands available.
The two modes are text mode and object mode.
Certain NVDA commands listed in this document may have a touch mode listed in brackets after the touch gesture.
For example, flick up (text mode) means that the command will be performed if you flick up, but only while in text mode.
If the command does not have a mode listed, it will work in any mode.
%kc:beginInclude
To toggle touch modes, perform a 3-finger tap.
%kc:endInclude
++ Input Help Mode ++
Many NVDA commands are mentioned throughout the rest of this user guide, but an easy way to explore all the different commands is to turn on input help.
To turn on input help, press NVDA+1.
To turn it off, press NVDA+1 again.
While in input help, performing any input gesture (such as pressing a key or performing a touch gesture) will report the action and describe what it does (if anything).
The actual commands will not execute while in input help mode.
++ The NVDA menu ++
The NVDA menu allows you to control NVDA's settings, access help, save/revert your configuration, Modify speech dictionaries, access additional tools and exit NVDA.
To get to the NVDA menu from anywhere in Windows while NVDA is running, press NVDA+n on the keyboard or perform a 2-finger double tap on the touch screen.
You can also get to the NVDA menu via the windows system tray.
Either right-click on the NVDA icon located in the system tray, or access the system tray by pressing the windows logo key+B, DownArrow to the NVDA icon and press the applications key located next to the right control key on most keyboards.
When the menu comes up, You can use the arrow keys to navigate the menu, and the enter key to activate an item.
++ Basic NVDA commands ++
%kc:beginInclude
|| Name | Desktop key | Laptop key | Touch | Description |
| Stop speech | Control | control | 2-finger tap | Instantly stops speaking |
| Pause Speech | shift | shift | none | Instantly pauses speech. Pressing it again will continue speaking where it left off (if pausing is supported by the current synthesizer) |
| NVDA Menu | NVDA+n | NVDA+n | 2-finger double tap | Pops up the NVDA menu to allow you to access preferences, tools, help, etc. |
| Toggle Speech Mode | NVDA+s | NVDA+s | none | Toggles speech mode between speech, beeps and off. |
| Toggle Input Help Mode | NVDA+1 | NVDA+1 | none | Pressing any key in this mode will report the key, and the description of any NVDA command associated with it |
| Quit NVDA | NVDA+q | NVDA+q | none | Exits NVDA |
| Pass next key through | NVDA+f2 | NVDA+f2 | none | Tells NVDA to pass the next key press straight through to the active application, even if it is normally treeted as an NVDA key command |
| Toggle application sleep mode on and off | NVDA+shift+s | NVDA+shift+z | none | sleep mode disables all NVDA commands and speech/braille output for the current application. This is most useful in applications that provide their own speech or screen reading features. Press this command again to disable self voicing mode. |
%kc:endInclude
++ Reporting System Information ++
%kc:beginInclude
|| Name | key | Description |
| Report date/time | NVDA+f12 | Pressing once reports the current time, pressing twice reports the date |
| Report battery status | NVDA+shift+b | Reports the battery status i.e. whether AC power is in use or the current charge percentage. |
| Report clipboard text | NVDA+c | Reports the Text in the clipboard if there is any. |
%kc:endInclude
+ Navigating with NVDA +
NVDA allows you to explore and navigate the system in several ways, including both normal interaction and review.
++ Objects ++[Objects]
Each Application and the operating system itself consist of many objects.
An object is a single item such as a piece of text, button, checkbox, slider, list or editable text field.
++ Navigating with the System Focus ++[SystemFocus]
The system focus, also known simply as the focus, is the [object #Objects] which receives keys typed on the keyboard.
For example, if you are typing into an editable text field, the editable text field has the focus.
The Most common way of navigating around Windows with NVDA is to simply move the system focus using standard Windows keyboard commands, such as pressing tab and shift+tab to move forward and back between controls, pressing alt to get to the menu bar and then using the arrows to navigate menus, and using alt+tab to move between running applications.
As you do this, NVDA will report information about the object with focus, such as its name, type, value, state, description, keyboard shortcut and positional information.
There are some key commands that are useful when moving with the System focus:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Description |
| Report current focus | NVDA+tab | NVDA+tab | announces the current object or control that has the System focus. Pressing twice will spell the information |
| Report title | NVDA+t | NVDA+t | Reports the title of the currently active window. Pressing twice will spell the information. Pressing three times will copy it to the clipboard |
| Read active window | NVDA+b | NVDA+b | reads all the controls in the currently active window (useful for dialogs) |
| Report Status Bar | NVDA+end | NVDA+shift+end | Reports the Status Bar if NVDA finds one. It also moves the navigator object to this location. Pressing twice will spell the information |
%kc:endInclude
++ Navigating with the System Caret ++[SystemCaret]
When an [object #Objects] that allows navigation and/or editing of text is [focused #SystemFocus], you can move through the text using the system caret, also known as the edit cursor.
When the focus is on an object that has the system caret, you can use the arrow keys, page up, page down, home, end, etc. to move through the text.
You can also change the text if the control supports editing.
NVDA will announce as you move by character, word and line, and will also announce as you select and unselect text.
NVDA provides the following key commands in relation to the system caret:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Description |
| Say all | NVDA+downArrow | NVDA+a | Starts reading from the current position of the system caret, moving it along as it goes |
| Read current line | NVDA+upArrow | NVDA+l | Reads the line where the system caret is currently situated. Pressing twice spells the line. |
| Read current text selection | NVDA+Shift+upArrow | NVDA+shift+s | Reads any currently selected text |
| Next sentence | alt+downArrow | alt+downArrow | Moves the caret to the next sentence and announces it. (only supported in Microsoft Word and Outlook) |
| Previous sentence | alt+upArrow | alt+upArrow | Moves the caret to the previous sentence and announces it. (only supported in Microsoft Word and Outlook) |
When within a table, the following key commands are also available:
|| Name | Key | Description |
| Move to previous column | control+alt+leftArrow | Moves the system caret to the previous column (staying in the same row) |
| Move to next column | control+alt+rightArrow | Moves the system caret to the next column (staying in the same row) |
| Move to previous row | control+alt+upArrow | Moves the system caret to the previous row (staying in the same column) |
| Move to next row | control+alt+downArrow | Moves the system caret to the next row (staying in the same column) |
%kc:endInclude
++ Object Navigation ++[ObjectNavigation]
Most of the time, you will work with applications using commands which move the [focus #SystemFocus] and the [caret #SystemCaret].
However, sometimes, you may wish to explore the current application or the Operating System without moving the focus or caret.
You may also wish to work with [objects #Objects] that cannot be accessed normally using the keyboard.
In these cases, you can use object navigation.
Object navigation allows you to move between and obtain information about individual [objects #Objects].
When you move to an object, NVDA will report it similarly to the way it reports the system focus.
For a way to review all text as it appears on the screen, you can instead use [screen review #ScreenReview].
Rather than having to move back and forth between every single object on the system, the objects are organized hierarchically.
This means that some objects contain other objects and you must move inside them to access the objects they contain.
For example, a list contains list items, so you must move inside the list in order to access its items.
If you have moved to a list item, moving next and previous will take you to other list items in the same list.
Moving to a list item's containing object will take you back to the list.
You can then move past the list if you wish to access other objects.
Similarly, a toolbar contains controls, so you must move inside the toolbar to access the controls in the toolbar.
The object currently being reviewed is called the navigator object.
Once you navigate to an object, you can review its content using the [text review commands #ReviewingText] while in [Object review mode #ObjectReview].
By default, the navigator object moves along with the System focus, though this behaviour can be toggled on and off.
Note that braille follows the [focus #SystemFocus] and [caret #SystemCaret] by default, rather than object navigation and text review.
If you want it to follow object navigation and text review instead, you need to [configure braille to be tethered to #BrailleTether] review.
To navigate by object, use the following commands:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Touch | Description |
| Report current object | NVDA+numpad5 | NVDA+shift+o | none | Reports the current navigator object. Pressing twice spells the information, and pressing 3 times copies this object's name and value to the clipboard. |
| Move to containing object | NVDA+numpad8 | NVDA+shift+upArrow | flick up (object mode) | Moves to the object containing the current navigator object |
| Move to previous object | NVDA+numpad4 | NVDA+shift+leftArrow | flick left (object mode) | Moves to the object before the current navigator object |
| Move to next object | NVDA+numpad6 | NVDA+shift+rightArrow | flick right (object mode) | Moves to the object after the current navigator object |
| Move to first contained object | NVDA+numpad2 | NVDA+shift+downArrow | flick down (object mode) | Moves to the first object contained by the current navigator object |
| Move to focus object | NVDA+numpadMinus | NVDA+backspace | none | Moves to the object that currently has the system focus, and also places the review cursor at the position of the System caret, if it is showing |
| Activate current navigator object | NVDA+numpadEnter | NVDA+enter | double tap | Activates the current navigator object (similar to clicking with the mouse or pressing space when it has the system focus) |
| Move System focus or caret to current review position | NVDA+shift+numpadMinus | NVDA+shift+backspace | none | pressed once Moves the System focus to the current navigator object, pressed twice moves the system caret to the position of the review cursor |
| Report review cursor location | NVDA+numpadDelete | NVDA+delete | none | Reports information about the location of the text or object at the review cursor. For example, this might include the percentage through the document, the distance from the edge of the page or the exact screen position. Pressing twice may provide further detail. |
%kc:endInclude
Note: numpad keys require numlock key to be turned off to work properly.
++ Reviewing Text ++[ReviewingText]
NVDA allows you to read the contents of the [screen #ScreenReview], current [document #DocumentReview] or current [object #ObjectReview] by character, word or line.
This is mostly useful in places (including Windows command consoles) where there is no [system caret #SystemCaret].
For example, you might use it to review the text of a long information message in a dialog.
When moving the review cursor, the System caret does not follow along, so you can review text without losing your editing position.
However, by default, when the System caret moves, the review cursor follows along.
This can be toggled on and off.
Note that braille follows the [focus #SystemFocus] and [caret #SystemCaret] by default, rather than object navigation and text review.
If you want it to follow object navigation and text review instead, you need to [configure braille to be tethered to #BrailleTether] review.
The following commands are available for reviewing text:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Touch | Description |
| Move to top line in review | shift+numpad7 | NVDA+control+home | none | Moves the review cursor to the top line of the text |
| Move to previous line in review | numpad7 | NVDA+upArrow | flick up (text mode) | Moves the review cursor to the previous line of text |
| Report current line in review | numpad8 | NVDA+shift+. | none | Announces the current line of text where the review cursor is positioned. Pressing twice spells the line. Pressing three times spells the line using character descriptions. |
| Move to next line in review | numpad9 | NVDA+downArrow | flick down (text mode) | Move the review cursor to the next line of text |
| Move to bottom line in review | shift+numpad9 | NVDA+control+end | none | Moves the review cursor to the bottom line of text |
| Move to previous word in review | numpad4 | NVDA+control+leftArrow | 2-finger flick left (text mode) | Moves the review cursor to the previous word in the text |
| Report current word in review | numpad5 | NVDA+control+. | none | Announces the current word in the text where the review cursor is positioned. Pressing twice spells the word. Pressing three times spells the word using character descriptions. |
| Move to next word in review | numpad6 | NVDA+control+rightArrow | 2-finger flick right (text mode) | Move the review cursor to the next word in the text |
| Move to start of line in review | shift+numpad1 | NVDA+home | none | Moves the review cursor to the start of the current line in the text |
| Move to previous character in review | numpad1 | NVDA+leftArrow | flick left (text mode) | Moves the review cursor to the previous character on the current line in the text |
| Report current character in review | numpad2 | NVDA+. | none | Announces the current character on the line of text where the review cursor is positioned. Pressing twice reports a description or example of that character. Pressing three times reports the numeric value of the character in decimal and hexadecimal. |
| Move to next character in review | numpad3 | NVDA+rightArrow | flick right (text mode) | Move the review cursor to the next character on the current line of text |
| Move to end of line in review | shift+numpad3 | NVDA+end | none | Moves the review cursor to the end of the current line of text |
| Say all with review | numpadPlus | NVDA+shift+a | 3-finger flick down (text mode) | Reads from the current position of the review cursor, moving it as it goes |
| Select then Copy from review cursor | NVDA+f9 | NVDA+f9 | none | Starts the select then copy process from the current position of the review cursor. The actual action is not performed until you tell NVDA where the end of the text range is |
| Select then Copy to review cursor | NVDA+f10 | NVDA+f10 | none | On the first press, text is selected from the position previously set start marker up to and including the review cursor's current position. After pressing this key a second time, the text will be copied to the Windows clipboard |
| Report text formatting | NVDA+f | NVDA+f | none | Reports the formatting of the text where the review cursor is currently situated. Pressing twice shows the information in browse mode |
%kc:endInclude
Note: numpad keys require numlock key to be turned off to work properly.
A good way to remember the basic text review commands when using the Desktop layout is to think of them as being in a grid of three by three, with top to bottom being line, word and character and left to right being previous, current and next.
The layout is illustrated as follows:
| Previous line | Current line | Next line |
| Previous word | Current word | Next word |
| Previous character | Current character | Next character |
++ Review Modes ++[ReviewModes]
NVDA's [text review commands #ReviewingText] can review content within the current navigator object, current document or screen, depending on the review mode selected.
Review modes are a replacement for the older Flat Review concept found in NVDA.
The following commands switch between review modes:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Touch | Description |
| switch to next review mode | NVDA+numpad7 | NVDA+pageUp | 2-finger flick up | switches to the next available review mode |
| switch to previous review mode | NVDA+numpad1 | NVDA+pageDown | 2-finger flick down | switches to the previous available review mode |
%kc:endInclude
+++ Object Review +++[ObjectReview]
While in object review mode, you are able to only review the content of the current [navigator object #ObjectNavigation].
For objects such as editable text fields or other basic text controls, this will generally be the text content.
For other objects, this may be the name and/or value.
+++ Document Review +++[DocumentReview]
When the [navigator object #ObjectNavigation] is within a browse mode document (e.g. web page) or other complex document (e.g. a Lotus Symphony document), it is possible to switch to the document review mode.
The document review mode allows you to review the text of the entire document.
When switching from object review to document review, the review cursor is placed in the document at the position of the navigator object.
When moving around the document with review commands, the navigator object is automatically updated to the object found at the current review cursor position.
Note that NVDA will switch to document review from object review automatically when moving around browse mode documents.
+++ Screen Review +++[ScreenReview]
The screen review mode allows you to review the text of the screen as it appears visually within the current application.
This is similar to the screen review or mouse cursor functionality in many other Windows screen readers.
When switching to screen review mode, the review cursor is placed at the screen position of the current [navigator object #ObjectNavigation].
When moving around the screen with review commands, the navigator object is automatically updated to the object found at the screen position of the review cursor.
Note that in some newer applications, NVDA may not see some or all text displayed on the screen due to the use of newer screen drawing technologies which are impossible to support at this time.
++ Navigating with the Mouse ++
When you move the Mouse, NVDA by default reports the text that is directly under the mouse pointer as the pointer moves over it.
Where supported, NVDA will read the surrounding paragraph of text, though some controls may only read by line.
NVDA can be configured to also announce the type of [object #Objects] under the mouse as it moves (e.g. list, button, etc.).
This may be useful for totally blind users, as sometimes, the text isn't enough.
NVDA provides a way for users to understand where the mouse is located relative to the dimensions of the screen by playing the current mouse coordinates as audio beeps.
The higher the mouse is on the screen, the higher the pitch of the beeps.
The further left or right the mouse is located on the screen, the further left or right the sound will be played (assuming the user has stereo speakers or headphones).
These extra mouse features are not turned on by default in NVDA.
If you wish to take advantage of them, you can configure them from the [Mouse settings #MouseSettings] dialog, found in the NVDA Preferences menu.
Although a physical mouse or trackpad should be used to navigate with the mouse, NVDA has a few key commands related to the mouse:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Description |
| Left mouse button click | numpadDivide | NVDA+[ | clicks the left mouse button once. The common double click can be performed by pressing this key twice in quick succession |
| Left mouse button lock | shift+numpadDivide | NVDA+control+[ | Locks the left mouse button down. Press again to release it. To drag the mouse, press this key to lock the left button down and then move the mouse either physically or use one of the other mouse routing commands |
| Right mouse click | numpadMultiply | NVDA+] | Clicks the right mouse button once. |
| Right mouse button lock | shift+numpadMultiply | NVDA+control+] | Locks the right mouse button down. Press again to release it. To drag the mouse, press this key to lock the right button down and then move the mouse either physically or use one of the other mouse routing commands |
| Move mouse to current navigator object | NVDA+numpadDivide | NVDA+shift+m | Moves the mouse to the location of the current navigator object and review cursor |
| Navigate to the object under the mouse | NVDA+numpadMultiply | NVDA+shift+n | Set the navigator object to the object located at the position of the mouse |
%kc:endInclude
+ Browse Mode +[BrowseMode]
Complex read-only documents such as web pages are browsed in NVDA using browse mode.
This includes documents in Mozilla Firefox, Microsoft Internet Explorer, Mozilla Thunderbird, HTML messages in Microsoft Outlook, Google Chrome, Adobe Reader and Adobe Flash.
Browse mode is also optionally available for Microsoft Word documents.
In browse mode, the content of the document is made available in a flat representation that can be navigated with the cursor keys as if it were a normal text document.
All of NVDA's [system caret #SystemCaret] key commands will work in this mode; e.g. say all, report formatting, table navigation commands, etc.
Information such as whether text is a link, heading, etc. is reported along with the text as you move.
Sometimes, you will need to interact directly with controls in these documents.
For example, you will need to do this for editable text fields and lists so that you can type characters and use the cursor keys to work with the control.
You do this by switching to focus mode, where almost all keys are passed to the control.
When in Browse mode, by default, NVDA will automatically switch to focus mode if you tab to or click on a particular control that requires it.
Conversely, tabbing to or clicking on a control that does not require focus mode will switch back to browse mode.
You can also press enter or space to switch to focus mode on controls that require it.
Pressing escape will switch back to browse mode.
In addition, you can manually force focus mode, after which it will remain in effect until you choose to disable it.
%kc:beginInclude
|| Name | Key | Description |
| Toggle browse/focus modes | NVDA+space | Toggles between focus mode and browse mode |
| Exit focus mode | escape | switches back to browse mode if focus mode was previously switched to automatically |
| Refresh browse mode document | NVDA+f5 | Reloads the current document content (useful if certain content seems to be missing from the document. Not available in Microsoft Word and Outlook.) |
| Find | NVDA+control+f | Pops up a dialog in which you can type some text to find in the current document |
| Find next | NVDA+f3 | Finds the next occurrence of the text in the document that you previously searched for |
| Find previous | NVDA+shift+f3 | Finds the previous occurrence of the text in the document you previously searched for |
| open long description | NVDA+d | Opens a new window containing a long description for the element you are on if it has one. |
%kc:endInclude
++ Single Letter Navigation ++
While in browse mode, For quicker navigation, NVDA also provides single character keys to jump to certain fields in the document.
Note that not all of these commands are supported in every type of document.
%kc:beginInclude
The following keys by themselves jump to the next available element, while adding the shift key causes them to jump to the previous element:
- h: heading
- l: list
- i: list item
- t: table
- k: link
- n: nonLinked text
- f: form field
- u: unvisited link
- v: visited link
- e: edit field
- b: button
- x: checkbox
- c: combo box
- r: radio button
- q: block quote
- s: separator
- m: frame
- g: graphic
- d: landmark
- o: embedded object
- 1 to 6: headings at levels 1 to 6 respectively
- a: annotation (comment, editor revision, etc.)
-
To move to the beginning or end of containing elements such as lists and tables:
|| Name | Key | Description |
| Move to start of container | shift+comma | Moves to the start of the container (list, table, etc.) where the caret is positioned |
| Move past end of container | comma | Moves past the end of the container (list, table, etc.) where the caret is positioned |
%kc:endInclude
Some web applications such as Gmail, Twitter and Facebook use single letters as shortcut keys.
If you want to use these while still being able to use your cursor keys to read in browse mode, you can temporarily disable NVDA's single letter navigation keys.
%kc:beginInclude
To toggle single letter navigation on and off for the current document, press NVDA+shift+space.
%kc:endInclude
++ The Elements List ++
The elements list provides access to a list of various types of elements in the document as appropriate for the application.
For example, in web browsers, the elements list can list links, headings or landmarks.
Radio buttons allow you to switch between the different types of elements.
An edit field is also provided in the dialog which allows you to filter the list to help you search for a particular item on the page.
Once you have chosen an item, you can use the provided buttons in the dialog to move to or activate that item.
%kc:beginInclude
|| Name | Key | Description |
| Browse mode elements list | NVDA+f7 | Lists various types of elements in the current document |
%kc:endInclude
++ Embedded Objects ++
Pages can include rich content using technologies such as Adobe Flash and Sun Java, as well as applications and dialogs.
Where these are encountered in browse mode, NVDA will report "embedded object", "application" or "dialog", respectively.
You can press enter on these objects to interact with them.
If it is accessible, you can then tab around it and interact with it like any other application.
A key command is provided to return to the original page containing the embedded object:
%kc:beginInclude
|| Name | Key | Description |
| Move to containing browse mode document | NVDA+control+space | Moves the focus out of the current embedded object and into the document that contains it |
%kc:endInclude
+ Reading Mathematical Content +
Using MathPlayer 4 from Design Science, NVDA can read and interactively navigate supported mathematical content.
This requires that MathPlayer 4 is installed on the computer.
MathPlayer is available as a free download from: http://www.dessci.com/en/products/mathplayer/
NVDA supports the following types of mathematical content:
- MathML in Mozilla Firefox and Microsoft Internet Explorer.
- Design Science MathType in Microsoft Word and PowerPoint. MathType needs to be installed in order for this to work. The trial version is sufficient.
- MathML in Adobe Reader. Note that this is not an official standard yet, so there is currently no publicly available software that can produce this content.
-
When reading a document, NVDA will speak any supported mathematical content where it occurs.
If you are using a braille display, it will also be displayed in braille.
++ Interactive Navigation ++
If you are working primarily with speech, in most cases, you will probably wish to examine the expression in smaller segments, rather than hearing the entire expression at once.
If you are in browse mode, you can do this by moving the cursor to the mathematical content and pressing enter.
If you are not in browse mode:
+ move the review cursor to the mathematical content.
By default, the review cursor follows the system caret, so you can usually use the system caret to move to the desired content.
+ Then, activate the following command:
+
%kc:beginInclude
|| Name | Key | Description |
| Interact with math content | NVDA+alt+m | Begins interaction with math content. |
%kc:endInclude
At this point, you can use MathPlayer commands such as the arrow keys to explore the expression.
For example, you can move through the expression with the left and right arrow keys and zoom into a portion of the expression such as a fraction using the down arrow key.
Please see the MathPlayer documentation for further information.
When you wish to return to the document, simply press the escape key.
+ Application Specific Features +
NVDA provides its own extra features for some applications to make certain tasks easier or to provide access to functionality which is not otherwise accessible to screen reader users.
++ Microsoft Word ++
+++ Automatic Column and Row Header Reading +++
NVDA is able to automatically announce appropriate row and column headers when navigating around tables in Microsoft Word.
This firstly requires that the Report Table row / column headers option In NVDA's Document Formatting dialog be turned on.
Secondly, NVDA needs to know which row or column contains the headers in any given table.
After moving to the first cell in the column or row containing the headers, use one of the following commands:
%kc:beginInclude
|| Name | Key | Description |
| Set column headers | NVDA+shift+c | Pressing this once tells NVDA this is the first header cell in the row that contains column headers, which should be automatically announced when moving between columns below this row. Pressing twice will clear the setting. |
| Set row headers | NVDA+shift+r | Pressing this once tells NVDA this is the first header cell in the column that contains row headers, which should be automatically announced when moving between rows after this column. Pressing twice will clear the setting. |
%kc:endInclude
These settings will be stored in the document as bookmarks compatible with other Screen Readers such as Jaws.
This means that users of other screen readers who open this document at a later date will automatically have the row and column headers already set.
+++ Browse Mode in Microsoft Word +++
Similar to the web, Browse mode can be used in Microsoft Word to allow you to use features such as Quick navigation and the Elements List.
%kc:beginInclude
To toggle Browse mode on and off in Microsoft Word, press NVDA+space.
%kc:endInclude
For further information about Browse mode and Quick Navigation, see the [Browse Mode section #BrowseMode].
++++ The Elements List ++++
%kc:beginInclude
While in Browse mode in Microsoft Word, you can access the Elements List by pressing NVDA+f7.
%kc:endInclude
The Elements List can list headings, links and annotations (which includes comments and track changes).
+++ Reporting Comments +++
%kc:beginInclude
To report any comments at the current caret position, press NVDA+alt+c.
%kc:endInclude
All comments for the document, along with other tracked changes, can also be listed in the NVDA Elements List when selecting Annotations as the type.
++ Microsoft Excel ++
+++ Automatic Column and Row Header Reading +++
NVDA is able to automatically announce appropriate row and column headers when navigating around Excel worksheets.
This firstly requires that the Report Table row / column headers option In NVDA's Document Formatting dialog be turned on.
Secondly, NVDA needs to know which row or column contains the headers.
After moving to the first cell in the column or row containing the headers, use one of the following commands:
%kc:beginInclude
|| Name | Key | Description |
| Set column headers | NVDA+shift+c | Pressing this once tells NVDA this is the first header cell in the row that contains column headers, which should be automatically announced when moving between columns below this row. Pressing twice will clear the setting. |
| Set row headers | NVDA+shift+r | Pressing this once tells NVDA this is the first header cell in the column that contains row headers, which should be automatically announced when moving between rows after this column. Pressing twice will clear the setting. |
%kc:endInclude
These settings will be stored in the workbook as defined name ranges compatible with other Screen Readers such as Jaws.
This means that users of other screen readers who open this workbook at a later date will automatically have the row and column headers already set.
+++ The Elements List +++
Similar to the web, NVDA has an Elements List for Microsoft Excel that allows you to list and access several different types of information.
%kc:beginInclude
To access the Elements List in Excel, press NVDA+f7.
%kc:endInclude
The various types of information available in the Elements List are:
- Charts: This lists all charts in the active worksheet.
Selecting a chart and pressing enter or the Move to button focuses the chart for navigating and reading with the arrow keys.
- Comments: This lists all cells in the active worksheet containing comments.
The cell address along with its comments are shown for each cell.
Pressing Enter or the Move To button when on a listed comment will move directly to that cell.
- Formulas: This lists all cells in the worksheet containing a formula.
The cell address along with its formula are shown for each cell.
Pressing Enter or the Move To button on a listed formula will move directly to that cell.
- Sheets: This lists all sheets in the workbook.
Pressing f2 when on a listed sheet allows you to rename the sheet.
Pressing Enter or the Move To button while on the listed sheet will switch to that sheet.
- Form fields: This lists all form fields in the active worksheet.
For each form field, the Elements List shows the alternative text of the field along with the addresses of the cells it covers.
Selecting a form field and pressing enter or the Move to button moves to that field in browse mode.
-
+++ Reporting Comments +++
%kc:beginInclude
To report any comments for the currently focused cell, press NVDA+alt+c.
%kc:endInclude
All comments for the Worksheet can also be listed in the NVDA Elements List.
+++ Reading Protected Cells +++
If a workbook has been protected, it may not be possible to move focus to particular cells that have been locked for editing.
%kc:beginInclude
To allow moving to locked cells, switch to Browse Mode by pressing NVDA+space, and then use standard Excel movement commands such as the arrow keys to move around all cells on the current worksheet.
%kc:endInclude
+++ Form Fields +++
Excel worksheets can include form fields.
You can access these using the Elements List or the f and shift+f form field single letter navigation keys.
Once you move to a form field in browse mode, you can press enter or space to either activate it or switch to focus mode so you can interact with it, depending on the control.
For further information about Browse mode and single letter navigation, see the [Browse Mode section #BrowseMode].
++ Microsoft PowerPoint ++
%kc:beginInclude
|| Name | Key | Description |
| Toggle speaker notes reading | control+shift+s | When in a running slide show, this command will toggle between the speaker notes for the slide and the content for the slide. This only affects what NVDA reads, not what is displayed on screen. |
%kc:endInclude
++ foobar2000 ++
%kc:beginInclude
|| Name | Key | Description |
| Report remaining time | control+shift+r | Reports the remaining time of the currently playing track, if any. |
%kc:endInclude
Note: The report remaining time shortcut works only with the default formatting string for foobar's status line.
++ Miranda IM ++
%kc:beginInclude
|| Name | Key | Description |
| Report recent message | NVDA+control+1-4 | Reports one of the recent messages, depending on the number pressed; e.g. NVDA+control+2 reads the second most recent message. |
%kc:endInclude
++ Poedit ++
%kc:beginInclude
|| Name | Key | Description |
| Report Comments Window | control+shift+c | Reports any comments in the comments window. |
| Report notes for translators | control+shift+a | Reports any notes for translators. |
%kc:endInclude
++ Skype ++
%kc:beginInclude
When in a conversation:
|| Name | Key | Description |
| Review message | NVDA+control+1-0 | Reports and moves the review cursor to a recent message, depending on the number pressed; e.g. NVDA+control+2 reads the second most recent message. |
%kc:endInclude
+ Configuring NVDA +
++ Preferences ++
%kc:settingsSection: || Name | Desktop key | Laptop key | Description |
Most NVDA settings can be changed using dialog boxes accessed through the Preferences sub-menu of the NVDA menu.
In all NVDA settings dialog boxes, press the OK button to accept any changes you have made.
To cancel any changes, press the Cancel button or the escape key.
Some settings can also be changed using shortcut keys, which are listed where relevant in the sections below.
Note that by default, not all preferences dialogs can be accessed with input gestures (keyboard commands, touch gestures, etc.).
If you wish to access dialogs which don't have dedicated shortcut keys, use the [Input Gestures dialog #InputGestures] to add custom gesture for that dialog.
+++ General Settings (NVDA+control+g) +++
The General settings dialog box is found in the Preferences menu.
It contains the following options:
==== Language ====
This is a combo box which allows you to select the language that NVDA's user interface and messages should be shown in.
There are many languages, however the default option is "User Default, Windows".
This option tells NVDA to use the language that Windows is currently set to.
Please note that NVDA must be restarted when changing the language.
NVDA will ask you if you wish to restart if you do change the selection.
Press OK, and NVDA will restart.
==== Save configuration on exit ====
This option is a checkbox that, when checked, tells NVDA to automatically save the current configuration when you exit NVDA.
==== Show exit options when exiting NVDA ====
This option is a checkbox that allows you to choose whether or not a dialog appears when you exit NVDA that asks what action you want to perform.
When checked, a dialog will appear when you attempt to exit NVDA asking whether you want to exit, restart or restart with add-ons disabled.
When unchecked, NVDA will exit immediately.
==== Play sounds when starting or exiting NVDA ====
This option is a checkbox that, when checked, tells NVDA to play sounds when it starts or exits.
==== Logging level ====
This is a combo box that permits you to choose how much NVDA will log as it's running.
Generally users should not need to touch this as not too much is logged.
However if you are wanting to provide information in a bug report, then it may be a useful option.
==== Automatically start NVDA after I log on to Windows ====
If this option is enabled, NVDA will start automatically as soon as you log on to Windows.
This option is only available for installed copies of NVDA.
==== Use NVDA on the Windows Logon screen (requires administrator privileges) ====
If you log on to Windows by providing a user name and password, then enabling this option will make NVDA start automatically at the logon screen when Windows starts.
This option is only available for installed copies of NVDA.
==== Use currently saved settings on the logon and other secure screens (requires administrator privileges) ====
Pressing this button copies your currently saved NVDA user configuration to NVDA's system configuration directory, so that NVDA will use it when running on the logon, User Account Control (UAC) and other secure Windows screens.
To make sure that all your settings are transferred, make sure to save your configuration first with control+NVDA+c or Save configuration in the NVDA menu.
This option is only available for installed copies of NVDA.
==== Automatically check for updates to NVDA ====
If this is enabled, NVDA will automatically check for updated versions of NVDA and inform you when an update is available.
You can also manually check for updates by selecting Check for updates under Help in the NVDA menu.
+++ Synthesizer Selection (NVDA+control+s) +++
The Synthesizer dialog, which is found under "Synthesizer..." in the Preferences menu, allows you to select which Synthesizer NVDA should use to speak with.
Once you have selected your synthesizer of choice, you can press Ok and NVDA will load the selected Synthesizer.
If there is an error loading the synthesizer, NVDA will notify you with a message, and continue using the previous synthesizer.
==== Synthesizer ====
This option allows you to choose the synthesizer you wish NVDA to use for speech output.
For a list of the Synthesizers that NVDA supports, please see the [Supported Speech Synthesizers #SupportedSpeechSynths] section.
One special item that will always appear in this list is "No speech", which allows you to use NVDA with no speech output what so ever.
This may be useful for someone who wishes to only use NVDA with Braille, or perhaps to sighted developers who only wish to use the Speech Viewer.
==== Output device ====
This option allows you to choose the sound card that NVDA should instruct the selected synthesizer to speak through.
%kc:setting
==== Audio Ducking Mode ====
Key: NVDA+shift+d
On Windows 8 and above, this option allows you to choose if NVDA should lower the volume of other applications while NVDA is speaking, or all the time while NVDA is running.
- No Ducking: NVDA will never lower the volume of other audio.
- Duck when outputting speech and sounds: NVDA will only lower the volume of other audio when NVDA is speaking or playing sounds. This may not work for all synthesizers.
- Always duck: NVDA will keep the volume of other audio lower the whole time NVDA is running.
-
+++ Voice Settings (NVDA+control+v) +++[VoiceSettings]
The Voice Settings dialog, found in the Preferences menu, contains options that let you change the sound of the speech.
For a quicker alternative way of controlling speech parameters from anywhere, please see the [Synth Settings Ring #SynthSettingsRing] section.
The Voice Settings dialog box contains the following options:
==== Voice ====
The first option that you land on in this dialog is a combo box listing all the voices of the current synthesizer that you have installed.
You can use the arrow keys to listen to all the various choices.
Left and Up arrow take you up in the list, while right and down arrow move you down in the list.
==== Variant ====
If you are using the Espeak NG synthesizer that is packaged with NVDA, this is a combo box that lets you select the Variant the synthesizer should speak with.
ESpeak NG's Variants are rather like voices, as they provide slightly different attributes to the eSpeak NG voice.
Some variants will sound like a male, some like a female, and some even like a frog.
==== Rate ====
This option allows you to change the rate of your voice.
This is a slider that goes from 0 to 100, (0 being the slowest, 100 being the fastest).
==== Pitch ====
This option allows you to change the pitch of the current voice.
It is a slider which goes from 0 to 100, (0 being the lowest pitch and 100 being the highest).
==== Volume ====
This option is a slider which goes from 0 to 100, (0 being the lowest volume and 100 being the highest).
==== Inflection ====
This option is a slider that lets you choose how much inflection (rise and fall in pitch) the synthesizer should use to speak with. (The only synthesizer that provides this option at the present time is eSpeak NG).
==== Automatic Language switching ====
This checkbox allows you to toggle whether NVDA should switch speech synthesizer languages automatically if the text being read specifies its language.
This option is enabled by default.
Currently only the eSpeak NG synthesizer supports automatic language switching.
==== Automatic Dialect switching ====
This checkbox allows you to toggle whether or not dialect changes should be made, rather than just actual language changes.
For example, if reading in an English U.S. voice but a document specifies that some text is in English U.K., then the synthesizer will switch accents if this option is enabled.
This option is disabled by default.
%kc:setting
==== Punctuation/Symbol Level ====
Key: NVDA+p
This allows you to choose the amount of punctuation and other symbols that should be spoken as words.
For example, when set to all, all symbols will be spoken as words.
This option applies to all synthesizers, not just the currently active synthesizer.
==== Trust voice's language for processing symbols and characters ====
On by default, this option tells NVDA if the current voice's language can be trusted when processing symbols and characters.
If you find that NVDA is reading punctuation in the wrong language for a particular synthesizer or voice, you may wish to turn this off to force NVDA to use its global language setting instead.
==== Capital pitch change percentage ====
This edit field allows you to type the amount that the pitch of the voice will change when speaking a capital letter.
This value is a percentage, where a negative value lowers the pitch and a positive value raises it.
For no pitch change you would use 0.
==== Say "cap" before capitals ====
This setting is a checkbox that, when checked, tells NVDA to say the word "cap" before any capital letter when spoken as an individual character such as when spelling.
Usually, NVDA raises the pitch slightly for any capital letter, but some synthesizers may not support this well, so perhaps this option may be of use.
==== Beep for capitals ====
If this checkbox is checked, NVDA will make a small beep each time it encounters a capitalized character by itself.
Like the "say cap for capitals" checkbox, this is useful for Synthesizers that can't change their pitch for capital letters.
==== Use spelling functionality if supported ====[VoiceSpellingFunctionality]
Some words consist of only one character, but the pronunciation is different depending on whether the character is being spoken as an individual character (such as when spelling) or a word.
For example, in English, "a" is both a letter and a word and is pronounced differently in each case.
This option allows the synthesizer to differentiate between these two cases if the synthesizer supports this.
Most synthesizers do support it.
This option should generally be enabled.
However, some Microsoft Speech API synthesizers do not implement this correctly and behave strangely when it is enabled.
If you are having problems with the pronunciation of individual characters, try disabling this option.
+++ Synth settings ring +++[SynthSettingsRing]
If you wish to quickly change speech settings without going to the Voice settings dialog, there are some NVDA key commands that allow you to move through the most common speech settings from anywhere while running NVDA:
%kc:beginInclude
|| Name | Desktop key | Laptop key | Description |
| Move to next synth setting | NVDA+control+rightArrow | NVDA+shift+control+rightArrow | Moves to the next available speech setting after the current, wrapping around to the first setting again after the last |
| Move to previous synth setting | NVDA+control+leftArrow | NVDA+shift+control+leftArrow | Moves to the next available speech setting before the current, wrapping around to the last setting after the first |
| Increment current synth setting | NVDA+control+upArrow | NVDA+shift+control+upArrow | increases the current speech setting you are on. E.g. increases the rate, chooses the next voice, increases the volume |
| Decrement current synth setting | NVDA+control+downArrow | NVDA+shift+control+downArrow | decreases the current speech setting you are on. E.g. decreases the rate, chooses the previous voice, decreases the volume |
%kc:endInclude
+++ Braille Settings +++
The braille settings dialog box can be invoked by going to the preferences menu and then to the braille settings option.
==== Braille Display ====
The first option you will come upon in the braille settings dialog is a combo box that says "braille display".
You will be presented with several options depending on what braille display drivers are available on your system.
Move between these options with the arrow keys.
No braille means that you are not using braille.
Please see the [Supported Braille Displays #SupportedBrailleDisplays] section for more information about supported braille displays.
==== Port ====
This option, if available, allows you to choose what port or type of connection will be used to communicate with the braille display you have selected.
It is a combo box containing the possible choices for your braille display.
By default, NVDA employs automatic port detection, which means the connection with the braille device will be established automatically by scanning for available USB and bluetooth devices on your system.
However, for some braille displays, you may be able to explicitly choose what port should be used.
Common options are "Automatic" (which tells NVDA to employ the default automatic port selection procedure), "USB", "Bluetooth" and legacy serial communication ports if your braille display supports this type of communication.
This option won't be available if your braille display only supports automatic port detection.
You may consult the documentation for your braille display in the section [Supported Braille Displays #SupportedBrailleDisplays] to check for more details on the supported types of communication and available ports.
==== Output Table ====
The next option you will come to in this dialog is the braille output table combo box.
In this combo box, you will find braille tables for different languages, braille standards and grades.
The chosen table will be used to translate text into braille to be presented on your braille display.
You can move from braille table to braille table in the list by using the arrow keys.
==== Input Table ====
Complementary to the previous option, the next setting you will find is the braille input table combo box.
The chosen table will be used to translate braille entered on your braille display's Perkins-style keyboard into text.
NVDA currently only supports computer braille input, so only 8 dot computer braille tables will be shown.
You can move from braille table to braille table in the list by using the arrow keys.
Note that this option is only useful if your braille display has a Perkins-style keyboard and this feature is supported by the braille display driver.
If input is not supported on a display which does have a braille keyboard, this will be noted in the [Supported Braille Displays #SupportedBrailleDisplays] section.
==== Expand to computer braille for the word at the cursor ====
This option allows the word that is under the cursor to be displayed in non-contracted computer braille.
==== Show Cursor ====
This option allows the braille cursor to be turned on and off.
It applies to the system caret and review cursor, but not to the selection indicator.
==== Cursor Blink Rate (ms) ====
This option is a numerical field that allows you to change the blink rate of the cursor in milliseconds.
==== Cursor Shape ====
This option allows you to choose the shape (dot pattern) of the braille cursor.
The selection indicator is not affected by this option.
==== Message Timeout (sec) ====
This option is a numerical field that controls how long NVDA messages are displayed on the braille display.
Specifying 0 disables displaying of these messages completely.
%kc:setting
==== Braille Tethered to ====[BrailleTether]
Key: NVDA+control+t
This option allows you to choose whether the braille display will follow the system focus, or whether it follows the navigator object / review cursor.
==== Read by Paragraph ====
If enabled, braille will be displayed by paragraphs instead of lines.
Also, the next and previous line commands will move by paragraph accordingly.
This means that you do not have to scroll the display at the end of each line even where more text would fit on the display.
This may allow for more fluent reading of large amounts of text.
It is disabled by default.
==== Avoid splitting words when possible ====
If this is enabled, a word which is too large to fit at the end of the braille display will not be split.
Instead, there will be some blank space at the end of the display.
When you scroll the display, you will be able to read the entire word.
This is sometimes called "word wrap".
Note that if the word is too large to fit on the display even by itself, the word must still be split.
If this is disabled, as much of the word as possible will be displayed, but the rest will be cut off.
When you scroll the display, you will then be able to read the rest of the word.
Enabling this may allow for more fluent reading, but generally requires you to scroll the display more.
+++ Keyboard Settings (NVDA+control+k) +++
This dialog box is found in the Preferences menu, under "Keyboard settings...".
It contains the following options:
==== Keyboard layout ====
This combo box lets you choose what type of keyboard layout NVDA should use. Currently the two that come with NVDA are Desktop and Laptop.
==== Use capslock as an NVDA modifier key ====
If this checkbox is checked, capslock can be used as an NVDA modifier key.
==== Use extended insert as an NVDA modifier key ====
If this checkbox is checked, the extended insert key (usually found above the arrow keys, near home and end) can be used as an NVDA modifier key.
==== Use numpad insert as an NVDA modifier key ====
If this checkbox is checked, the insert key on the number pad can be used as an NVDA modifier key.
If no key is chosen as the NVDA key it may be impossible to access certain NVDA commands.
Therefore, The Keyboard Settings dialog will display an error message if all keys are unselected when pressing Ok.
After dismissing the error message, you must select at least one before being able to press Ok to dismiss the dialog properly.
%kc:setting
==== Speak Typed Characters ====
Key: NVDA+2
When enabled, NVDA will announce all characters you type on the keyboard.
%kc:setting
==== Speak Typed Words ====
Key: NVDA+3
When enabled, NVDA will announce all words you type on the keyboard.
==== Speech interrupt for typed characters ====
If on, this option will cause speech to be interrupted each time a character is typed. This is on by default.
==== Speech interrupt for Enter key ====
If on, this option will cause speech to be interrupted each time the Enter key is pressed. This is on by default.
==== Allow skim reading in Say All ====
If on, certain navigation commands (such as quick navigation in browse mode or moving by line or paragraph) do not stop Say All, rather Say All jumps to the new position and continues reading.
==== Beep if Typing Lowercase Letters when Caps Lock is On ====
When enabled, a warning beep will be heard if a letter is typed with the shift key while caps lock is on.
Generally, typing shifted letters with caps lock is unintentional and is usually due to not realising that caps lock is enabled.
Therefore, it can be quite helpful to be warned about this.
%kc:setting
==== Speak Command Keys ====
Key: NVDA+4