~stomato463/+junk/nvdajp

« back to all changes in this revision

Viewing changes to user_docs/en/userGuide.t2t

  • Committer: Masataka Shinke
  • Date: 2011-10-25 12:35:26 UTC
  • mfrom: (4185 jpmain)
  • mto: This revision was merged to the branch mainline in revision 4211.
  • Revision ID: mshinke@users.sourceforge.jp-20111025123526-ze527a2rl3z0g2ky
lp:~nishimotz/nvdajp/main : 4185 をマージ

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
NVDA NVDA_VERSION User Guide
2
 
Last update: 16 March 2010
3
 
 
4
 
%!includeconf: ../userGuide.conf.t2t
 
2
 
 
3
 
 
4
%!includeconf: ../userGuide.t2tconf
 
5
%kc:title: NVDA NVDA_VERSION Keyboard Commands Quick Reference
5
6
 
6
7
= Table of Contents =[toc]
7
8
%%toc
8
9
 
9
10
+ Introduction +
 
11
NonVisual Desktop Access (NVDA) is a free and open source screen reader for the Microsoft Windows operating system.
 
12
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.
 
13
NVDA is developed by [NV Access http://www.nvaccess.org/], with contributions from the community.
10
14
 
11
15
++ General Features ++
12
 
Providing feedback by synthetic speech, Nonvisual Desktop Access allows blind and vision impaired people to access and interact with the Windows operating system and many third party applications.
 
16
NVDA allows blind and vision impaired people to access and interact with the Windows operating system and many third party applications.
13
17
 
14
18
Major highlights include:
 
19
- Support for popular applications including web browsers, email clients, internet chat programs and office suites
 
20
- Builtin  speech synthesizer supporting over 20 languages
 
21
- announcement of textual formatting where available such as font name and size, style and spelling errors
 
22
- Automatic announcement of text under the mouse and optional audible indication of the mouse position
 
23
- Support for many refreshable braille displays
15
24
- Ability to run entirely from a USB stick or other portable media without the need for installation
16
25
- Easy to use talking installer
17
 
- Browsing the web with [Mozilla Firefox 3 http://www.getfirefox.com/]
18
 
- Working with email using [Mozilla Thunderbird 3 http://www.mozillamessaging.com/en-US/thunderbird/early_releases/]
19
 
- Support for Microsoft Internet Explorer
20
 
- Basic support for Microsoft Outlook Express / Windows Mail
21
 
- support for Microsoft Word and Excel
22
 
- Support for accessible Java applications
23
 
- Support for Adobe Reader
24
 
- Early support for IBM Lotus Symphony
 
26
- Translated into many languages
 
27
- Support for modern Windows Operating Systems including both 32 and 64 bit variants
 
28
- Ability to run on Windows logon and other secure screens
 
29
- Support for common accessibility  interfaces such as Microsoft Active Accessibility, Java Access Bridge, IAccessible2 and UI Automation
25
30
- support for Windows Command Prompt and console applications
26
 
- Automatic announcement of text under the mouse and optional audible indication of the mouse position
27
 
- Support for many refreshable Braille displays
28
31
-
29
32
 
30
33
++ Internationalization ++
31
 
It is important that people anywhere in the world, no matter what language they speak, get equal access to technology. NVDA currently has been translated into over 20 languages besides the English language including: Arabic, Brazilian Portuguese, Croatian, Czech, Finnish, French, Galician, German, Hungarian, Italian, Japanese, Portuguese, Russian, Slovak, Spanish, Thai, Traditional Chinese, Ukrainian, Afrikaans, Polish and Vietnamese.
 
34
It is important that people anywhere in the world, no matter what language they speak, get equal access to technology.
 
35
Besides English, NVDA has been translated into 34 languages including: Afrikaans, Albanian, Arabic, Brazilian Portuguese, Bulgarian, Croatian, Czech, Danish, Dutch, Finnish, French, Galician, Georgian, German, Hebrew, Hindi, Hungarian, Icelandic, Italian, Japanese, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Spanish, Swedish, Thai, Traditional Chinese, Taiwanese Mandarin, Turkish, Ukrainian and Vietnamese.
32
36
 
33
37
++ Speech Synthesizer Support ++
34
 
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 particular language.
35
 
 
36
 
NVDA is bundled with [eSpeak http://espeak.sourceforge.net/], a free, open-source, multi-lingual speech synthesizer. Additionally, NVDA can use both SAPI4 and SAPI5 speech engines to provide speech output, as well as the Audiologic and NewFon speech synthesizers.
 
38
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.
 
39
 
 
40
NVDA is bundled with [eSpeak http://espeak.sourceforge.net/], a free, open-source, multi-lingual speech synthesizer.
 
41
 
 
42
Information about  other speech synthesizers that NVDA supports can be found in the [Supported Speech Synthesizers #SupportedSpeechSynths] section.
37
43
 
38
44
++ Braille support ++
39
 
For users that own a refreshable braille display, NVDA can output its information in braille. NVDA supports Freedom Scientific Pacmate and Focus displays, Handy Tech displays, ALVA BC640/680 displays, plus many others supported by the BRLTTY package if it is available.
 
45
For users that own a refreshable braille display, NVDA can output its information in Braille.
 
46
Please see the [Supported Braille Displays #SupportedBrailleDisplays] section for information about the supported braille displays.
40
47
 
41
 
NVDA supports many braille codes covering a large set of languages. In many cases grade 1 and 2 versions of the codes are available. For English readers both U.S. English braille and Unified English braille (UEB) codes are included.
 
48
NVDA supports braille codes for many languages, including contracted, uncontracted and computer braille codes for some languages.
42
49
 
43
50
++ Licence and Copyright ++
44
51
NVDA is copyright NVDA_COPYRIGHT_YEARS NVDA contributors.
45
52
 
46
 
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 you distribute the licence along with the software, and make all source code available to anyone who wants it. This applies to both original and modified copies of the software, plus any software that uses code taken from this software.
47
 
 
 
53
NVDA is covered by the GNU General Public License (Version 2).
 
54
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.
 
55
This applies to both original and modified copies of this software, plus any derivative works. 
48
56
For further details, you can [view the full licence. http://www.gnu.org/licenses/old-licenses/gpl-2.0.html]
49
57
 
50
58
+ System Requirements +
51
 
- Operating Systems: all 32-bit and 64-bit versions of Windows XP, Windows Vista and Windows 7 (including Server operating Systems), may partially work on Windows 2000.
 
59
- Operating Systems: all 32-bit and 64-bit versions of Windows XP, Windows Vista and Windows 7 (including Server operating Systems).
52
60
- Memory: 256 mb or more of RAM
53
61
- Processor speed: 1.0 ghz or above
54
62
- About 50 MB of storage space.
55
63
-
56
64
 
57
65
+ Getting NVDA +
58
 
If you have not yet got a copy of NVDA, you can download it [here NVDA_URL].
 
66
If you have not yet got a copy of NVDA, you can download it from [www.nvda-project.org NVDA_URL].
59
67
 
60
68
Go to the download section and you will find a link to download the latest version of NVDA.
61
69
 
62
 
There are currently two ways NVDA is packaged. One is an Installer which will talk you through installing NVDA so that you can then run it at any time from the Start Menu. The other is a self-extracting archive file that contains a fully portable version of NVDA, which you can run from anywhere, including a USB thumb drive or CD.
 
70
There are currently two ways NVDA is packaged.
 
71
One is an Installer which will talk you through installing NVDA so that you can then run it at any time from the Start Menu.
 
72
The other is a self-extracting archive file that contains a fully portable version of NVDA, which you can run from anywhere, including a USB thumb drive or CD.
 
73
 
 
74
In order to access the Windows logon screen, User Account Control (UAC) screen or other secure Windows screens, as well as applications running as administrator in Windows Vista and later, you must install NVDA on your system using the installer.
 
75
These screens cannot be accessed using a portable copy of NVDA.
63
76
 
64
77
+ Installing NVDA +
65
78
 
66
79
++ The NVDA Installer ++
67
80
If you already have the NVDA installer, simply press enter or double click on the file and the installer will start.
68
81
 
69
 
As the installer loads, you will hear the NVDA installation music. Once loaded, a temporary copy of NVDA will allow you to follow the prompts of the installer and install NVDA. Note that if you were running another copy of NVDA at the time you started the installer, a message will appear telling you that your previous copy of NVDA will be closed. When you press enter on this message, the installer will close your previous copy and start its own one. This is necessary so that the installer can properly update any changed files. At this point, if you have another copy of NVDA already installed, the NVDA installer will uninstall it for you, and then it will commence to install NVDA.
 
82
As the installer loads, you will hear the NVDA installation music.
 
83
Once loaded, a temporary copy of NVDA will allow you to follow the prompts of the installer and install NVDA.
 
84
Note that if you were running another copy of NVDA at the time you started the installer, the installer will close your previous copy and start its own.
 
85
This is necessary so that the installer can properly update any changed files.
 
86
At this point, if you have another copy of NVDA already installed, the NVDA installer will uninstall it for you, and then it will commence to install NVDA.
70
87
 
71
 
Once you have successfully completed the installation, the installer will alert you that the install of NVDA has finished. If reinstalling NVDA, It may ask you to reboot the system at this point. It is very important that you reboot the system as failing to do so will have undesirable consequences. If it did not ask you to reboot, pressing Finnish will close the installer and start the newly installed version of NVDA.
 
88
Once you have successfully completed the installation, the installer will alert you that the install of NVDA has finished.
 
89
If reinstalling NVDA, It may ask you to reboot the system at this point.
 
90
It is very important that you reboot the system as failing to do so will have undesirable consequences.
 
91
If it did not ask you to reboot, pressing Finnish will close the installer and start the newly installed version of NVDA.
72
92
 
73
93
++ NVDA portable ++
74
 
If you have the portable version of NVDA, then all you have to do is to press enter or double click on the file, and follow the prompts. It will ask you where on your system you wish to place the files.
 
94
If you have the portable version of NVDA, then all you have to do is to press enter or double click on the file, and follow the prompts.
 
95
It will ask you where on your system you wish to place the files.
 
96
 
 
97
+++ NVDA Portable on a USB key +++
 
98
It is possible to place NVDA on a USB thumb drive so that you can use it on other computer systems.
 
99
 
 
100
When the Portable version asks where you wish to unpack it, type in the drive of your USB thumb drive, plus an optional subdirectory where you wish to place NVDA.
 
101
 
 
102
If for example your USB thumb drive is at E:\, you might wish to type in E:\nvda, which will place NVDA in the NVDA subdirectory on your USB thumb drive.
 
103
 
 
104
Note that although this now means you can carry around NVDA and its settings with you anywhere, simply plugging in the USB thumb drive will not automatically start NVDA; You will have to start NVDA manually from either Windows Explorer or the Run Dialog.
 
105
 
 
106
For information about automatically starting NVDA from a USB thumb drive, please see this article:
 
107
http://www.nvda-project.org/wiki/RunningAutomaticallyFromAUSBDrive
75
108
 
76
109
+ Getting started with NVDA +
77
110
 
78
111
++ Launching NVDA ++
79
 
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.
 
112
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.
 
113
Additionally you can type NVDA into the Run dialog and press Enter.
80
114
 
81
115
To start the portable version, go to the directory you unpacked NVDA to, and press enter or double click on nvda.exe.
82
116
 
83
 
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 subsystems. Please wait..."
84
 
 
85
 
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.
86
 
 
87
 
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 two checkboxes. The first lets you control if NVDA should use the capslock as an NVDA modifier key, and the second lets you control if this Welcome dialog should appear each time NVDA starts.
 
117
As NVDA starts, you will first hear an ascending set of tones (telling you that NVDA is loading).
 
118
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.
 
119
If it is taking an extra long time, NVDA should say "Loading NVDA. Please wait..."
 
120
 
 
121
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.
 
122
Please check out the NVDA website for how to do this.
 
123
 
 
124
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.
 
125
(Please see further sections about these topics).
 
126
The dialog box also contains two checkboxes.
 
127
The first lets you control if NVDA should use the capslock as an NVDA modifier key, and the second lets you control if this Welcome dialog should appear each time NVDA starts.
88
128
 
89
129
++ About NVDA keyboard commands ++
90
 
Most NVDA-specific keyboard commands usually consist of pressing the NVDA modifier key, in conjunction with one or more other keys. An exception to this are the text review commands which just use the numpad keys by themselves.
91
 
 
92
 
By default both numpad insert and extended insert can be used as the NVDA modifier key. However, you can also configure NVDA so that the capslock key also becomes an NVDA modifier key. When configured this way, pressing or holding down capslock acts as an NVDA modifier key, but pressing it twice in quick succession causes it to act as the normal capslock key.
93
 
 
94
 
Many key commands are mentioned through out the rest of this user guide, but an easy way to explore all the different key commands is to turn on keyboard help.
95
 
 
96
 
To turn on keyboard help, press NVDA+1. To turn it off again, press NVDA+1 again. While in keyboard help, pressing any key will announce what it does (if in deed it does do something). The keys will not actually perform their function while in keyboard help mode, so you can press what ever keys you like.
 
130
 
 
131
+++ The NVDA Modifier Key +++
 
132
Most NVDA-specific keyboard commands usually consist of pressing  a particular  key called   the NVDA modifier key, in conjunction with one or more other keys.
 
133
An exception to this are the text review commands which just use the numpad keys by themselves.
 
134
 
 
135
NVDA can be configured so that either the numpad Insert, Extended Insert, or capslock key can be used as the NVDA modifier key.
 
136
 
 
137
By default, both the numpad Insert and Extended Insert keys are set as NVDA modifier keys.
 
138
 
 
139
If you wish to cause one of the NVDA modifier keys to act like its original key (for instance 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.
 
140
 
 
141
+++ Input Help Mode +++
 
142
Many key commands are mentioned through out the rest of this user guide, but an easy way to explore all the different key commands is to turn on input help.
 
143
 
 
144
To turn on input help, press NVDA+1.
 
145
To turn it off again, press NVDA+1 again.
 
146
While in input help, pressing any key will announce what it does (if in deed it does do something).
 
147
The keys will not actually perform their function while in input help mode, so you can press what ever keys you like.
 
148
 
 
149
+++ Keyboard Layouts +++
 
150
NVDA currently comes with two sets of key commands.
 
151
There is a layout for Desktops and a layout for Laptops.
 
152
NVDA by default 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.
 
153
 
 
154
The Desktop layout makes heavy use of the numberpad (with numlock off).
 
155
Although most laptops do not have a physical numberpad, 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).
 
156
If your laptop can not do this, or does not allow you to turn numlock off, you may want to switch to the Laptop layout instead.
97
157
 
98
158
++ The NVDA menu ++
99
 
The NVDA menu allows you to control NVDA's settings, access help, save/revert your configuration, Modify speech dictionaries, read the log file, and exit NVDA.
100
 
 
101
 
To get to the NVDA menu from anywhere in Windows while NVDA is running, press NVDA+n. 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. The Preferences menu allows you to configure NVDA how you like, the tools menu contains useful tools such as the NVDA log viewer and the NVDA Python console for developers, the help menu allows you to access the user guide, a quick key reference, and much more. The NVDA menu also contains items that allow you to save or revert your current configuration. There is also an option that allows you to exit NVDA, although this can be accomplished more efficiently by pressing NVDA+Q.
 
159
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.
 
160
 
 
161
To get to the NVDA menu from anywhere in Windows while NVDA is running, press NVDA+n.
 
162
You can also get to the NVDA menu via the windows system tray.
 
163
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.
 
164
When the menu comes up, You can use the arrow keys to navigate the menu, and the enter key to activate an item.
 
165
 
 
166
%kc:beginInclude
 
167
|| Name | Key | Description |
 
168
| Stop speech | Control | Instantly stops speaking |
 
169
| Pause Speech | Shift | Instantly pauses speech. Pressing it again will continue speaking where it left off (if pausing is supported by the current synthesizer) |
 
170
| NVDA Menu | NVDA+n | Pops up the NVDA menu to allow you to access preferences, tools and help etc |
 
171
| Toggle Speech Mode | NVDA+s | Toggles speech mode between speech, beeps and off. |
 
172
| Toggle Keyboard Help Mode | NVDA+1 | Pressing any key in this mode will report the key, and the description of any  NVDA command associated with it |
 
173
| Quit NVDA | NVDA+q | Exits NVDA |
 
174
| Pass next key through | NVDA+f2 | 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 |
 
175
| toggle application sleep mode on and off | NVDA+shift+s | 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. |
 
176
%kc:endInclude
 
177
 
 
178
%kc:beginInclude
 
179
|| Name | key | Description |
 
180
| Report date/time | NVDA+f12 | Pressing once reports the current time, pressing twice reports the date |
 
181
| Report battery status | NVDA+shift+b | Reports the battery status i.e. whether AC power is in use or  the current charge percentage. |
 
182
| Report clipboard text | NVDA+c | Reports the Text in the clipboard if there is any. |
 
183
%kc:endInclude
102
184
 
103
185
+ Navigating with NVDA +
104
 
 
105
 
++ Navigating with the Focus ++
106
 
The Most common way of navigating around Windows with NVDA, is to just move around with normal keyboard commands, such as 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, using alt+tab to move between running applications. As you do this, NVDA will announce what has focus.
107
 
 
108
 
When NVDA announces an object (e.g. when it receives focus), it will usually say the object's name, type, state, value, description, keyboard shortcut, and positional information. This is quite similar to other screen readers; however the types of objects may be a little different.
109
 
 
110
 
There are some key commands that are useful when moving with focus:
111
 
- NVDA+tab - reports the current focus
112
 
- NVDA+b - reads the entire foreground window (useful for reading a dialog box)
113
 
- NVDA+t - Announces the title of the current foreground window
114
 
-
115
 
 
116
 
++ Navigating with the System Caret ++
117
 
When the focus is on an object that has an edit cursor (system caret), you can arrow around and edit like you normally would. NVDA will announce as you move by character, word, line, and will also announce selecting and unselecting text.
118
 
 
119
 
When you move with the system caret, the position of the review cursor will also be updated to match the system caret. Though this setting can be toggled by the key command NVDA+6.
 
186
NVDA allows you to explore and navigate the system in several ways, including both normal interaction and review.
 
187
 
 
188
Each Application and the operating system itself consist of many objects.
 
189
An object is a single item such as a piece of text, button, checkbox, slider, list or editable text field.
 
190
 
 
191
The system focus, also known simply as the focus, is the [object #Objects] which receives keys typed on the keyboard.
 
192
For example, if you are typing into an editable text field, the editable text field has the focus.
 
193
 
 
194
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.
 
195
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.
 
196
 
 
197
There are some key commands that are useful when moving with the System focus:
 
198
%kc:beginInclude
 
199
|| Name | key | Description |
 
200
| Report current focus | NVDA+tab | announces the current object or control that has the System focus. Pressing twice will spell the information  |
 
201
| Report title | NVDA+t | Announces the title of the currently active window. Pressing twice will spell the information. Pressing thrice will copy it to the clipboard |
 
202
| Read active window | NVDA+b | reads all the controls in the currently active window (useful for dialogs) |
 
203
| Report Status Bar | NVDA+end | Reports the Status Bar if NVDA finds one. It also moves the navigator object to this location |
 
204
%kc:endInclude
 
205
 
 
206
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.
 
207
 
 
208
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.
 
209
You can also change the text if the control supports editing.
 
210
NVDA will announce as you move by character, word and line, and will also announce as you select and unselect text.
120
211
 
121
212
NVDA provides the following key commands in relation to the system caret:
122
 
- NVDA+downArrow: start reading from the position of the system caret, moving it as it goes
123
 
- NVDA+upArrow: read the current line at the system caret
124
 
- NVDA+Shift+upArrow: read the currently selected text if any
125
 
- NVDA+f: report the format of the text under the system caret
126
 
-
127
 
 
128
 
When with in a table, the following key commands are also available:
129
 
- control+alt+leftArrow: Move to the previous column (staying in this row)
130
 
- control+alt+rightArrow: move to the next column (staying in this row)
131
 
- control+alt+upArrow: move to the previous row (staying in this column)
132
 
- control+alt+downArrow: move to the next row (staying in this column)
133
 
-
 
213
%kc:beginInclude
 
214
|| Name | Key | Description |
 
215
| Say all | NVDA+downArrow | Starts reading from the current position of the system caret, moving it along as it goes |
 
216
| Read current line | NVDA+upArrow | Reads the line where the system caret is currently situated. Pressing twice spells the line. |
 
217
| Read current text selection | NVDA+Shift+upArrow | Reads any  currently selected text |
 
218
 
 
219
 
 
220
When within a table, the following key commands are also available:
 
221
|| Name | Key | Description |
 
222
| Move to previous column | control+alt+leftArrow | Moves the system caret to the previous column (staying in the same row) |
 
223
| Move to next column | control+alt+rightArrow | Moves the system caret to the next column (staying in the same row) |
 
224
| Move to previous row | control+alt+upArrow | Moves the system caret to the previous row (staying in the same column) |
 
225
| Move to next row | control+alt+downArrow | Moves the system caret to the next row (staying in the same column) |
 
226
%kc:endInclude
134
227
 
135
228
++ Object Navigation ++
136
 
If you wish to navigate around the current application or the Operating System a bit, but with out moving the focus, you can use NVDA's object navigation. This allows you to move from object to object in a tree like structure.
137
 
 
138
 
The tree structure of objects starts at the desktop window, the root of the tree. The first branches of the tree are the currently running applications, and of course these applications have their own branches (objects), representing various parts of the application.
139
 
 
140
 
The tree structure can get quite large, but it does allow you to navigate in a logical order, so that you can quickly find the information you need.
141
 
 
142
 
This structure has nothing to do with how the objects are laid out on the screen, but how they are related logically. This may take a little bit of time to get used to, but once you grasp this, you should be able to move around quite easily.
143
 
 
144
 
NVDA currently can not navigate the objects in a screen-based layout due to not having a video intercept driver or display hooks. NVDA chooses not to interact with the screen, more so because over all it should allow a much clearer, and more logical perception of an application and the operating system, rather than trying to picture a flat screen layout.
145
 
 
146
 
Not all applications have a perfect tree structure, but this is up to the developer of that particular application. Most seem to be ok; certainly most Dialog boxes and highly structured applications seem to have gotten it right.
 
229
Sometimes, you may wish to explore the current application or the Operating System without moving the [focus #SystemFocus].
 
230
You may also wish to work with [objects #Objects] that cannot be accessed normally using the keyboard.
 
231
In these cases, you can use object navigation.
 
232
 
 
233
Object navigation allows you to move between and obtain information about individual objects.
 
234
When you move to an object, NVDA will report it similarly to the way it reports the system focus.
 
235
For a way to review all text as it appears on the screen, you can instead use [flat review #FlatReview].
 
236
 
 
237
Rather than having to move back and forth between every single object on the system, the objects are organized hierarchically.
 
238
This means that some objects contain other objects and you must move inside them to access the objects they contain.
 
239
For example, a list contains list items, so you must move inside the list in order to access its items.
 
240
If you have moved to a list item, you can move to its containing object to get back to the list and then move past it if you wish.
 
241
Similarly, if you encounter a toolbar, you must move inside the toolbar to access the controls in the toolbar.
 
242
 
 
243
The object currently being reviewed is called the navigator object.
 
244
Once you navigate to an object, you can review it using the [text review commands #ReviewingText].
 
245
By default, the navigator object moves along with the System focus, though this behaviour can be toggled on and off.
147
246
 
148
247
To navigate by object, use the following keys:
149
 
- NVDA+numpad5: Speak current object
150
 
- NVDA+numpad8: Move to parent object (moving towards the root of the tree)
151
 
- NVDA+numpad4: Move to previous object (the object directly before this one on the same level)
152
 
- NVDA+numpad6: Move to Next object (the object directly after this one on the same level)
153
 
- NVDA+numpad2: Move to first child object (The first branch coming out of this one)
154
 
- NVDA+shift+numpad4: Move to previous object in flow (crosses parent child object boundaries automatically until it can go previous)
155
 
- NVDA+shift+numpad6: Move to next object in flow (crosses parent child object boundaries automatically until it can go next)
156
 
- NVDA+numpadMinus: Move to focus
157
 
- NVDA+numpadEnter: Activate current object (e.g. press enter / click / double click)
158
 
- NVDA+Shift+NumpadMinus: Move focus to the current object
159
 
- NVDA+numpadDivide: Move the mouse to the current object
160
 
- NVDA+numpadMultiply: Move to the mouse
161
 
- NVDA+numpadDelete: announce current object's dimentions in regards to the screen
162
 
- NVDA+numpadPlus: say all objects - starts reading from the current object, traveling next in flow
163
 
-
164
 
 
165
 
note: numpad keys require numlock key to be turned off to work properly
166
 
 
167
 
When you move with the focus, the current navigator object changes along with it. However, if you wish to lock the object navigation to one specific object, so it doesn't change with the focus, you can turn off focus Moves Navigator Object with NVDA+7.
168
 
 
169
 
++ Reviewing the Text in the Current Object ++
170
 
NVDA allows you to read the contents of the current navigator object, by character, word or line. This is mostly useful in Dos console windows, and other places where there is a limited or non-existant system caret.
171
 
- Shift+numpad7: Top line
172
 
- numpad7: Previous line
173
 
- numpad8: Current line
174
 
- numpad9: Next line
175
 
- shift+numpad9: Bottom line
176
 
- numpad4: Previous word
177
 
- numpad5: Current word
178
 
- numpad6: Next word
179
 
- shift+numpad1: Start of line
180
 
- numpad1: Previous character
181
 
- numpad2: Current character
182
 
- numpad3: Next character
183
 
- shift+numpad3: End of line
184
 
- numpad Plus: Say all text
185
 
-
186
 
 
187
 
note: numpad keys require numlock key to be turned off to work properly
188
 
 
189
 
When an object contains an edit cursor (system caret), and it moves, the review cursor is also updated to that position. If you want the review cursor to stay where it is, and not move with the caret, you can turn off caret Moves Review Cursor by pressing NVDA+6.
190
 
 
191
 
It is possible to copy parts of the text you are reviewing. For example, you may wish to copy an internet address someone has sent you in a text chat program. To copy text, Start by moving the review cursor to the first character of the text you wish to copy, and press NVDA+f9. Then move to the end of the text, and press NVDA+f10. The text will now be copied to the clipboard so that you can paste it somewhere else. Note that if the program you are using already allows you to move through the text using the system caret, and copy using the normal control+c command, then you will always get better results using this.
 
248
 
 
249
%kc:beginInclude
 
250
|| Name | Desktop key | Laptop key | Description |
 
251
| Report current object | NVDA+numpad5 | NVDA+control+i | Reports the current navigator object. Pressing twice spells the information, and pressing 3 times copies this object's name and value to the clipboard. |
 
252
| Move to containing object | NVDA+numpad8 | NVDA+shift+i | Moves to the object containing the current navigator object |
 
253
| Move to previous object | NVDA+numpad4 | NVDA+control+j | Moves to the object before the current navigator object |
 
254
| Move to next object | NVDA+numpad6 | control+NVDA+l | Moves to the object after the current navigator object |
 
255
| Move to first contained object | NVDA+numpad2 | NVDA+shift+comma | Moves to the first object contained by the current navigator object |
 
256
| Move to focus object | NVDA+numpadMinus | NVDA+backspace | 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 |
 
257
| Activate current navigator object | NVDA+numpadEnter | NVDA+enter | Activates the current navigator object (similar to  clicking with the mouse or pressing space when it has the system focus) |
 
258
| Move System focus or caret to current review position | NVDA+shift+numpadMinus | NVDA+shift+backspace | pressed once Moves the System focus to the current navigator object, pressed twice moves the system caret to the position of the review cursor |
 
259
| Report navigator object dimensions | NVDA+numpadDelete | NVDA+delete | Announces the current navigator object's dimensions on screen in per centages (including distance from left and top of screen, and its width and height) |
 
260
%kc:endInclude
 
261
 
 
262
note: numpad keys require numlock key to be turned off to work properly.
 
263
 
 
264
NVDA allows you to read the contents of the current [navigator object #ObjectNavigation] (including [flat review #FlatReview]) by character, word or line.
 
265
This is mostly useful in Windows command console windows and other places where there is a limited or non-existant [system caret #SystemCaret].
 
266
 
 
267
When moving the review cursor, the System caret does not follow along, so you can review text with out losing your editing position.
 
268
However, by default, when the System caret moves, the review cursor follows along.
 
269
This can be toggled on and off.
 
270
 
 
271
The following key commands are available for reviewing text:
 
272
%kc:beginInclude
 
273
|| Name | Desktop key | Laptop key | Description |
 
274
| move to  top line in review | shift+numpad7 | NVDA+7 | Moves the review cursor to the top line of the text |
 
275
| Move to previous line in review | numpad7 | NVDA+u | Moves the review cursor to the previous line of text |
 
276
| Report current line in review | numpad8 | NVDA+i | 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. |
 
277
| Move to next line in review | numpad9 | NVDA+o | Move the review cursor to the next line of text |
 
278
| Move to bottom line in review | shift+numpad9 | NVDA+9 | Moves the review cursor to the bottom line of text |
 
279
| Move to previous word in review | numpad4 | NVDA+j | Moves the review cursor to the previous word in the  text |
 
280
| Report current word in review | numpad5 | NVDA+k | 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. |
 
281
| Move to next word in review | numpad6 | NVDA+l | Move the review cursor to the next word in the text |
 
282
| move to  start of  line in review | shift+numpad1 | NVDA+shift+u | Moves the review cursor to the start of the  current line in the   text |
 
283
| Move to previous character in review | numpad1 | NVDA+m | Moves the review cursor to the previous character on the current line in  the text |
 
284
| Report current character in review | numpad2 | NVDA+comma | 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. |
 
285
| Move to next character in review | numpad3 | NVDA+dot | Move the review cursor to the next character on the current line of text |
 
286
| Move to end of line in review | shift+numpad3 | NVDA+shift+o | Moves the review cursor to the end  of the current line of text |
 
287
| Say all with review | numpadPlus | NVDA+shift+downArrow | Reads from the current position of the review cursor, moving it as it goes |
 
288
| copy from review cursor | NVDA+f9 | NVDA+f9 | starts copying text from the current position of the review cursor. The actual copy is not performed until you tell NVDA where to copy to |
 
289
| Copy to review cursor | NVDA+f10 | NVDA+f10 | Copies from the position of the review cursor currently set with Copy from review cursor, to the review cursor's current position. After pressing this key, the text will  be copied to the Windows clipboard |
 
290
| Report text formatting | NVDA+f | Announces the formatting of the text where the review cursor  is currently situated |
 
291
%kc:endInclude
 
292
 
 
293
note: numpad keys require numlock key to be turned off to work properly.
 
294
 
 
295
To help you remember these commands, note that the basic text review commands are organized 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.
 
296
The layout is illustrated as follows:
 
297
| Previous line | Current line | Next line |
 
298
| Previous word | Current word | Next word |
 
299
| Previous character | Current character | Next character |
 
300
 
 
301
While you can generally only review the content of a single [object #Objects], some objects allow you to review the content of objects inside them.
 
302
Complex documents allow you to review their entire content and application windows allow you to review the text of the screen as it appears visually.
 
303
This is called flat review.
 
304
This is similar to the screen review or mouse cursor functionality in many other Windows screen readers.
 
305
 
 
306
When you move to flat review, you will be positioned at the location of the current [navigator object #ObjectNavigation].
 
307
If you haven't used object navigation, this will usually be the object that has the [focus #SystemFocus].
 
308
For example, if the navigator object was a button, you will usually be positioned on the text of the button in flat review.
 
309
You can then review the text using the [text review commands #ReviewingText].
 
310
You can also navigate directly to the object encompassing the current position of the review cursor, allowing you to use [object navigation #ObjectNavigation] from there.
 
311
 
 
312
The following two commands are used for switching to/from flat review:
 
313
%kc:beginInclude
 
314
|| Name | Desktop key | Laptop key | Description |
 
315
| Move to flat review | NVDA+numpad7 | NVDA+pageUp | Moves to flat review, placing you at the position of the current navigator object, allowing you to  review the screen (or document if you are currently inside one) with the text review commands. |
 
316
| Move to object from flat review | NVDA+numpad1 | NVDA+pageDown | navigates to the object represented by the text at the current position of the review cursor in flat review |
 
317
%kc:endInclude
192
318
 
193
319
++ Navigating with the Mouse ++
194
 
When you move the Mouse, NVDA by default reports the text that is directly under the mouse pointer, as it moves over it. Where supported, NVDA will read a paragraph's worth of text, though some controls may only read by line.
195
 
 
196
 
NVDA can also be configured to also announce the type of control or object the mouse is currently over as it moves (e.g. list, button etc), which may be useful for totally blind users as sometimes the text isn't enough.
197
 
 
198
 
NVDA provides a way for users to understand where the mouse is in regards to the dimentions 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 more left or right the mouse is on the screen, the more left or right the sound will seem to come from (assuming the user has stereo speakers).
199
 
 
200
 
These extra mouse features are not turned on by default in NVDA, but if you wish to take advantage of them, you can configure them from the Mouse settings dialog, found in the Preferences menu on the NVDA menu.
 
320
When you move the Mouse, NVDA by default reports the text that is directly under the mouse pointer as the pointer moves over it.
 
321
Where supported, NVDA will read the surrounding paragraph of text, though some controls may only read by line.
 
322
 
 
323
NVDA can be configured to also announce the type of [object #Objects] under the mouse as it moves (e.g. list, button, etc.).
 
324
This may be useful for totally blind users, as sometimes, the text isn't enough.
 
325
 
 
326
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.
 
327
The higher the mouse is on the screen, the higher the pitch of the beeps.
 
328
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).
 
329
 
 
330
These extra mouse features are not turned on by default in NVDA.
 
331
If you wish to take advantage of them, you can configure them from the [Mouse settings #MouseSettings] dialog, found in the NVDA Preferences menu.
201
332
 
202
333
Although a physical mouse or trackpad should be used to navigate with the mouse, NVDA has a few key commands related to the mouse:
203
 
- numpadDivide: Left mouse button click
204
 
- numpadMultiply: Right mouse button click
205
 
- Shift+numpadDivide: Lock/Unlock left mouse button down
206
 
- Shift+numpadMultiply: Lock/Unlock right mouse button down
207
 
-
208
 
 
209
 
+ Virtual Buffers +
210
 
Complex read-only documents, such as web pages, are represented in NVDA with in a Virtual Buffer.
211
 
 
212
 
A virtual buffer is a flat representation of content such as a web page, that can be moved around in with the arrow keys. Information such as whether text is a link, heading etc is announced along with the text as you move.
213
 
 
214
 
While in a virtual buffer, there are two modes of interaction. Browse mode is where you can move around all the text using a virtual cursor, rather like the system caret. In fact all of NVDA's system caret key commands will work in this mode (e.g. say all, report formatting, all table navigation commands etc). Focus mode is where you can directly interact with the control (edit field, combo box, radio buttons) using what ever keys you would normally use. When in Browse mode, NVDA will automatically switch to focus mode if you tab to or click on a particular control that requires it. Note that pressing enter or space on controls that require it will also switch to focus mode. You can also manually change to focus mode with NVDA+space. If NVDA automatically changed to focus mode because of a tab, click or enter/space key press, it will change back to browse mode once you tab or click on to something that doesn't require it, or if you press escape. However, if you changed to focus mode with NVDA+space, it will stay in focus mode until you manually go back to browse mode. At any time when you are in focus mode, you can manually switch back to browse mode by pressing escape, or NVDA+space. The virtual buffer settings dialog in the preferences menu in the NVDA menu allows you to disable automatic switching of browse mode and focus mode.
215
 
 
216
 
Currently NVDA uses Virtual Buffers for reading documents in Mozilla Firefox, Microsoft Internet Explorer, and Adobe Reader.
 
334
%kc:beginInclude
 
335
|| Name | Desktop key | Laptop key | Description |
 
336
| Left mouse button click | numpadDivide | NVDA+leftArrow | clicks the left mouse button once. The common double click can be performed by pressing this key twice in quick succession |
 
337
| Left mouse button lock | shift+numpadDivide | NVDA+shift+leftArrow | 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 |
 
338
| Right mouse click | numpadMultiply | NVDA+rightArrow | Clicks the right mouse button once. |
 
339
| Right mouse button lock | shift+numpadMultiply | NVDA+shift+rightArrow | 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 |
 
340
| Move mouse to current navigator object | NVDA+numpadDivide | NVDA+shift+f9 | Moves the mouse to the location of the current navigator object and review cursor |
 
341
| navigate to the object under the mouse | NVDA+numpadMultiply | NVDA+shift+f10 | Set the navigator object to the object located at the position of the mouse |
 
342
%kc:endInclude
 
343
 
 
344
+ Browse Mode +
 
345
Complex read-only documents such as web pages are browsed in NVDA using browse mode.
 
346
This includes documents in Mozilla Firefox, Microsoft Internet Explorer, Google Chrome, Adobe Reader and Adobe Flash.
 
347
 
 
348
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.
 
349
All of NVDA's [system caret #SystemCaret] key commands will work in this mode; e.g. say all, report formatting, table navigation commands, etc.
 
350
Information such as whether text is a link, heading, etc. is announced along with the text as you move.
 
351
 
 
352
Sometimes, you will need to interact directly with controls in these documents.
 
353
You do this by switching to focus mode, where all keys are passed to the control.
 
354
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.
 
355
Conversely, tabbing to or clicking on a control that does not require focus mode will switch back to browse mode.
 
356
You can also press enter or space to switch to focus mode on controls that require it.
 
357
Pressing escape will switch back to browse mode.
 
358
In addition, you can manually force focus mode, after which it will remain in effect until you choose to disable it.
 
359
 
 
360
%kc:beginInclude
 
361
|| Name | Key | Description |
 
362
| Toggle browse/focus modes | NVDA+space | Toggles between focus mode and browse mode |
 
363
| Exit focus mode | escape | switches back to browse mode if focus mode was previously switched to automatically |
 
364
| Refresh browse mode document | NVDA+f5 | Reloads the current document content (useful if certain content seems to be missing from the document) |
 
365
| Find | NVDA+control+f | Pops up a dialog in which you can type some text to find in the current document |
 
366
| Find next | NVDA+f3 | Finds the next occurence of the text in the document that you previously searched for |
 
367
| Find previous | NVDA+shift+f3 | Finds the previous occurence of the text in the document you previously searched for |
 
368
%kc:endInclude
 
369
 
217
370
 
218
371
++ Single Letter Navigation ++
219
 
While in browse mode, For quicker navigation NVDA also provides single character keys to jump to certain fields in a virtual buffer.
220
 
 
221
 
By themselves they jump to the next field, with the shift key they jump to the previous field.
222
 
 
223
 
Available keys:
 
372
While in browse mode, For quicker navigation, NVDA also provides single character keys to jump to certain fields in the document.
 
373
 
 
374
%kc:beginInclude
 
375
The following keys by themselves jump to the next available element, while adding the shift key causes them to jump to the previous element:
224
376
- h: heading
225
377
- l: list
226
378
- i: list item
241
400
- g: graphic
242
401
- d: ARIA landmark
243
402
- o: embedded object
244
 
- 1 to 6: headings 1 to 6 respectively
 
403
- 1 to 6: headings at levels 1 to 6 respectively
245
404
-
246
 
 
247
 
++ Forms and Focus Mode ++
248
 
Sometimes you may wish to interact with form fields with out the virtual buffer keys getting in the way. Focus mode is created for this purpose, and can be toggled on and off with NVDA+space.
 
405
%kc:endInclude
249
406
 
250
407
++ The Elements List ++
251
 
The elements list (available by pressing NVDA+f7 while in a virtual buffer) provides access to a list of either links, headings or ARIA landmarks on the page. Radio buttons allow you to switch between these three types of information. 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.
 
408
The elements list provides access to a list of either links, headings or ARIA landmarks in the document.
 
409
Radio buttons allow you to switch between these three types of information.
 
410
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.
 
411
Once you have chosen an item, you can use the provided buttons in the dialog to move to or activate that item.
 
412
%kc:beginInclude
 
413
|| Name | Key | Description |
 
414
| Browse mode elements list | NVDA+f7 | Brings up the Elements list which contains links, headings and landmarks  from  the current document |
 
415
%kc:endInclude
252
416
 
253
417
++ Embedded Objects ++
254
 
Pages can include rich content using technologies such as Adobe Flash and Sun Java. Where these are encountered in a virtual buffer, NVDA will announce "embedded object". 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. To return to the page, press NVDA+control+space.
 
418
Pages can include rich content using technologies such as Adobe Flash and Sun Java.
 
419
Where these are encountered in  browse mode, NVDA will announce "embedded object".
 
420
You can press enter on these objects to interact with them.
 
421
If it is accessible, you can then tab around it and interact with it like any other application.
 
422
A key command is provided to return to the original page containing the embedded object:
 
423
%kc:beginInclude
 
424
|| Name | Key | Description |
 
425
| 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 |
 
426
%kc:endInclude
255
427
 
256
428
+ Configuring NVDA +
257
429
 
258
430
++ Preferences ++
 
431
%kc:settingsSection: || Name | Desktop key | Laptop key | Description |
 
432
Most NVDA settings can be changed using dialog boxes accessed through the Preferences sub-menu of the NVDA menu.
 
433
In all NVDA settings dialog boxes, press the OK button to accept any changes you have made.
 
434
To cancel any changes, press the Cancel button or the escape key.
 
435
Some settings can also be changed using shortcut keys, which are listed where relevant in the sections below.
259
436
 
260
 
+++ General Settings +++
261
 
The General settings dialog box is found in the Preferences menu. It is also accessed by pressing NVDA+Control+G. To save the options after modifying settings, press the OK button. To cancel, press the cancel button or the escape key. It contains the following options:
 
437
+++ General Settings (NVDA+control+g) +++
 
438
The General settings dialog box is found in the Preferences menu.
 
439
It contains the following options:
262
440
 
263
441
==== Language ====
264
 
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.
 
442
A combo box which allows you to select the language that NVDA's user interface and messages should be shown in.
 
443
There are many languages, however the default option is "User Default, Windows".
 
444
This option tells NVDA to use the language that Windows is currently set to.
265
445
 
266
 
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.
 
446
Please note that NVDA must be restarted when changing the language.
 
447
NVDA will ask you if you wish to restart if you do change the selection.
 
448
Press OK, and NVDA will restart.
267
449
 
268
450
==== Save Configuration on Exit ====
269
451
This option is a checkbox that, when checked, tells NVDA to automatically save the current configuration when you exit NVDA.
270
452
 
271
453
==== Warn before exiting NVDA ====
272
 
This option is a checkbox that allows you to choose whether or not a dialog appears when you exit NVDA that asks whether or not you would like to exit. When checked, a dialog will appear when you attempt to exit NVDA asking whether or not you want to exit.
 
454
This option is a checkbox that allows you to choose whether or not a dialog appears when you exit NVDA that asks whether or not you would like to exit.
 
455
When checked, a dialog will appear when you attempt to exit NVDA asking whether or not you want to exit.
273
456
 
274
457
==== Logging level ====
275
 
This is a combo box that permits you to choose how much NVDA wil 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.
 
458
This is a combo box that permits you to choose how much NVDA wil log as it's running.
 
459
Generally users should not need to touch this as not too much is logged.
 
460
However if you are wanting to provide information in a bug report, then it may be a useful option.
276
461
 
277
 
==== Automatically start nvda after I log on to windows ====
 
462
==== Automatically start NVDA after I log on to Windows ====
278
463
If this option is enabled, NVDA will start automatically as soon as you log on to Windows.
 
464
This option is only available for installed copies of NVDA.
279
465
 
280
 
==== Use nvda on the windows log on screen (requires administrative privileges) ====
 
466
==== Use NVDA on the windows Logon screen (requires administrative privileges) ====
281
467
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.
282
 
 
283
 
+++ Synthesizer Selection +++
284
 
The Synthesizer dialog, which is found under "Synthesizer..." in the Preferences menu or by pressing NVDA+Control+S, allows you to select which Synthesizer NVDA should use to speak with.
285
 
 
286
 
The dialog contains a simple combo box, which lists all the available synthesizers. Choose the synthesizer you want using the arrow keys, and then press ok. If there is an error loading the synthesizer, a message box will alert you, and NVDA will keep the old synthesizer loaded.
287
 
 
288
 
The current list of synthesizers NVDA supports is: eSpeak, SAPI4, SAPI5, Audiologic, and Silence.
289
 
 
290
 
The eSpeak synthesizer is built directly in to NVDA, and does not depend on any other special drivers or SAPI runtime to be installed. NVDA starts using eSpeak by default. This synthesizer should work on any system that NVDA works on, so it will definitely work when running NVDA off a USB thumb drive or CD, on anyone else's system.
291
 
 
292
 
The Sapi4 option allows you to use the Sapi synthesizer. Voices that are included under Ssapi4 include eloquence voices, as well as other Ssapi4 voices that you may have installed on your system.
293
 
 
294
 
The Sapi5 synthesizer allows you to use the microsoft voices that are iincluded on your machine. In XP, the default Ssapi5 voice is Microsoft Sam. In Vista, the default voice is Microsoft Anna. Depending on what voices you have installed, others may show up under Ssapi5.
295
 
 
296
 
The Silence synthesizer driver is not that useful, unless you want to not have any speech at all while running NVDA.
297
 
 
298
 
Please note that no matter how many different SAPI4 or SAPI5 voices (or engines) you have installed on your system, only the actual SAPI4 and SAPI5 synthesizers will show up in the Synthesizers dialog. To actually select one of the engines (voices), select either SAPI4 or SAPI5, and then in the Voice settings dialog, you can choose the voice you want.
299
 
 
300
 
+++ Voice Settings +++
301
 
The Voice Settings dialog, found in the Preferences menu or accessed by pressing NVDA+Control+V, contains options that let you change the sound of the speech. You can also configure many of the options from anywhere by pressing NVDA+Control along with one of the arrow keys. The left and right arrow keys move through the various settings, the up and down arrows increase or decrease that setting respectively.
302
 
 
 
468
This option is only available for installed copies of NVDA.
 
469
 
 
470
==== Use currently saved settings on the logon and other secure screens ====
 
471
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.
 
472
To make sure that all your settings are transfered, make sure to firstly save your configuration with control+NVDA+c or save configuration in the NVDA menu.
 
473
This option is only available for installed copies of NVDA.
 
474
 
 
475
+++ Synthesizer Selection (NVDA+control+s) +++
 
476
The Synthesizer dialog, which is found under "Synthesizer..." in the Preferences menu, allows you to select which Synthesizer NVDA should use to speak with.
 
477
Once you have selected your synthesizer of choice, you can press Ok and NVDA will load the selected Synthesizer.
 
478
If there is an error loading the synthesizer, NVDA will notify you with a message, and continue using the previous synthesizer.
 
479
 
 
480
==== Synthesizer ====
 
481
This option allows you to choose the synthesizer you wish NVDA to use for speech output.
 
482
 
 
483
For a list of the Synthesizers that NVDA supports, please see the [Supported Speech Synthesizers #SupportedSpeechSynths] section.
 
484
 
 
485
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.
 
486
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.
 
487
 
 
488
==== Output device ====
 
489
This option allows you to choose the sound card that NVDA should instruct the selected synthesizer to speak through.
 
490
 
 
491
+++ Voice Settings (NVDA+control+v) +++[VoiceSettings]
 
492
The Voice Settings dialog, found in the Preferences menu, contains options that let you change the sound of the speech.
 
493
For a quicker alternative way of controlling speech parameters from anywhere, please see the [Synth Settings Ring #SynthSettingsRing] section.
 
494
 
303
495
The Voice Settings dialog box contains the following options:
304
496
 
305
497
==== Voice ====
306
 
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 moves you down in the list.
 
498
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.
 
499
You can use the arrow keys to listen to all the various choices.
 
500
Left and Up arrow take you up in the list, while right and down arrow moves you down in the list.
307
501
 
308
502
==== Variant ====
309
 
If you are using the Espeak synthesizer that is packaged with NVDA, this is a combo box that lets you select the Variant the synthesizer should speak with. ESpeak's Variants are rather like voices, as they provide slightly different attributes to the eSpeak voice. Some variants will sound like a male, some like a female, and some even like a frog.
 
503
If you are using the Espeak synthesizer that is packaged with NVDA, this is a combo box that lets you select the Variant the synthesizer should speak with.
 
504
ESpeak's Variants are rather like voices, as they provide slightly different attributes to the eSpeak voice.
 
505
Some variants will sound like a male, some like a female, and some even like a frog.
310
506
 
311
507
==== Rate ====
312
 
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).
 
508
This option allows you to change the rate of your voice.
 
509
This is a slider that goes from 0 to 100, (0 being the slowest, 100 being the fastest).
313
510
 
314
511
==== Pitch ====
315
 
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).
 
512
This option allows you to change the pitch of the current voice.
 
513
It is a slider which goes from 0 to 100, (0 being the lowest pitch and 100 being the highest).
316
514
 
317
515
==== Volume ====
318
516
This option is a slider which goes from 0 to 100, (0 being the lowest volume and 100 being the highest).
320
518
==== Inflection ====
321
519
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).
322
520
 
323
 
==== Speak All Punctuation ====
324
 
This setting is a checkbox, that when checked, tells NVDA to speak all punctuation symbols as words (very useful for proof reading). When unchecked, NVDA leaves the punctuation unchanged, so the synthesizer will still read sentences with the right inflection, however the symbols won't be spoken aloud.
325
 
 
326
 
==== Raise pitch for capitals ====
327
 
This setting, if checked, will raise the pitch for capitals.
328
 
 
329
 
==== Say "CAP" before capitals ====
330
 
This setting is a checkbox, that when checked, tells NVDA to say the word "cap;" before any capital letter, when arrowing over it or speaking it when its being typed. 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.
 
521
==== Automatic Language switching ====
 
522
This checkbox allows you to toggle whether or not NVDA should switch speech synthesizer languages on the fly, if language markup is available in the text being read.
 
523
This option is enabled by default.
 
524
Currently only the eSpeak synthesizer supports automatic language switching.
 
525
 
 
526
==== Automatic Dialect switching ====
 
527
If automatic language switching is turned on, this checkbox allows you to toggle whether or not  dialect changes should be made, rather than just actual language changes. E.g. If reading in an English U.S. voice but a document states some text is in English U.K. then if this feature is enabled the synthesizer will switch accents.
 
528
this option is disabled by default.
 
529
 
 
530
%kc:setting
 
531
==== Punctuation/Symbol Level ====
 
532
Key: NVDA+p
 
533
 
 
534
This allows you to choose the amount of punctuation and other symbols that should be spoken as words.
 
535
For example, when set to all, all symbols will be spoken as words.
 
536
This option applies to all synthesizers, not just the currently active synthesizer.
 
537
 
 
538
==== Capital pitch change percentage ====
 
539
This edit field  allows you to type the amount that the pitch of the voice will change when speaking a capital letter.
 
540
This value is a percentage, where a negative value lowers the pitch and a positive value raises it.
 
541
For no pitch change you would use 0.
 
542
 
 
543
==== Say "cap" before capitals ====
 
544
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.
 
545
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.
331
546
 
332
547
==== Beep for capitals ====
333
 
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.
 
548
If this checkbox is checked, NVDA will make a small beep each time it encounters a capitalized character by itself.
 
549
Like the 'say cap for capitals' checkbox, this is useful for Synthesizers that can't change their pitch for capital letters.
 
550
 
 
551
==== Use spelling functionality if supported ====[VoiceSpellingFunctionality]
 
552
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.
 
553
For example, in English, "a" is both a letter and a word.
 
554
This option allows the synthesizer to differentiate between these two cases if the synthesizer supports this.
 
555
Most synthesizers do support it.
 
556
 
 
557
This option should generally be enabled.
 
558
However, some Microsoft Speech API synthesizers do not implement this correctly and behave strangely when it is enabled.
 
559
If you are having problems with the pronunciation of individual characters, try disabling this option.
 
560
 
 
561
+++ Synth settings ring +++[SynthSettingsRing]
 
562
If you wish to quickly change speech  settings  with out 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:
 
563
%kc:beginInclude
 
564
|| Name | Desktop key | Laptop key | Description |
 
565
| Move to next synth setting | NVDA+control+rightArrow | NVDA+control+rightArrow | Moves to the next available speech setting after the current, wrapping around to the first setting again after the last |
 
566
| Move to previous synth setting | NVDA+control+leftArrow | NVDA+control+leftArrow | Moves to the next available speech setting before the current, wrapping around to the last setting after the first |
 
567
| Increment current synth setting | NVDA+control+upArrow | NVDA+control+upArrow | increases the current speech setting you are on. E.g. increases the rate, chooses the next voice, increases the volume |
 
568
| Decrement current synth setting | NVDA+control+downArrow | NVDA+control+downArrow | decreases the current speech setting you are on. E.g. decreases the rate, chooses the previous voice, decreases the volume |
 
569
%kc:endInclude
334
570
 
335
571
+++ Braille Settings +++
336
572
The braille settings dialog box can be invoked by going to the preferences menu and then to the braille settings option.
337
573
 
338
574
==== Braille Display ====
339
 
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 three options. Move between these options with the arrow keys.
 
575
The first option you will come upon in the braille settings dialog is a combo box that says "braille display".
 
576
You will be presented with several options depending on what braille display drivers are available on your system.
 
577
Move between these options with the arrow keys.
340
578
 
341
579
No braille means that you are not using braille.
342
580
 
343
 
Freedom Scientific is for Freedom Scientific Focus/Pacmate displays. Note that this option only appears if you have the braille driver from Freedom Scientific installed, see [Official Freedom Scientific braille drivers page http://www.freedomscientific.com/PACMATE-HQ/FS_Braille_Display_Driver.asp] for more info on how to obtain and install the drivers.
344
 
 
345
 
Handy Tech is for the Handy Tech displays. Note that this option will only exist if you have installed the [Handy Tech Universal Driver ftp://ftp.handytech.de/public/Software/BrailleDriver/bsd1111a.exe]
346
 
 
347
 
BRLTTY allows you to use a wide list of braille displays. Please install the [BRLTTY Windows installer http://brl.thefreecat.org/brltty/] in order to get support for these displays.
 
581
Please see the [Supported Braille Displays #SupportedBrailleDisplays] section for more information about supported braille displays.
348
582
 
349
583
==== Translation Table ====
350
 
The next option you will come to in this dialog is the braille table combo box. In this combo box, you will find braille tables for different languages. You can move from braille table to braille table in the list by using the arrow keys.
 
584
The next option you will come to in this dialog is the braille table combo box.
 
585
In this combo box, you will find braille tables for different languages. You can move from braille table to braille table in the list by using the arrow keys.
351
586
 
352
587
==== Expand to computer braille for the word at the cursor ====
353
588
This option allows the word that is under the cursor to be displayed in non-contracted computer braille.
358
593
==== Message Timeout (sec) ====
359
594
This option is a numerical field that controls how long system messages are displayed on the braille display.
360
595
 
 
596
%kc:setting
361
597
==== Braille Tethered to ====
 
598
Key: NVDA+control+t
 
599
 
362
600
This option allows you to choose whether the braille display will follow the system focus, or whether it follows the navigator object / review cursor.
363
601
 
364
 
This option can also be toggled by the key command NVDA+control+t.
365
 
 
366
 
+++ Keyboard settings +++
367
 
This dialog box is found in the Preferences menu, under "Keyboard settings...". Alternatively, it can be accessed by pressing NVDA+Control+K. It contains the following options:
 
602
+++ Keyboard settings (NVDA+control+k) +++
 
603
This dialog box is found in the Preferences menu, under "Keyboard settings...".
 
604
It contains the following options:
368
605
 
369
606
==== Keyboard layout ====
370
607
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.
378
615
==== Use numpad insert as an NVDA modifier key ====
379
616
If this checkbox is checked, the insert key on the number pad can be used as an NVDA modifier key.
380
617
 
 
618
%kc:setting
381
619
==== Speak Typed Characters ====
382
 
A checkbox that when checked means that NVDA will announce all characters you type on the keyboard. You can also configure this option from anywhere by pressing NVDA+2.
383
 
 
 
620
Key: NVDA+2
 
621
 
 
622
When enabled, NVDA will announce all characters you type on the keyboard.
 
623
 
 
624
%kc:setting
384
625
==== Speak Typed Words ====
385
 
A checkbox that when checked means that NVDA will announce all words you type on the keyboard. You can also configure this option from anywhere by pressing NVDA+3.
386
 
 
 
626
Key: NVDA+3
 
627
 
 
628
When enabled, NVDA will announce all words you type on the keyboard.
 
629
 
 
630
==== Beep if Typing Lowercase Letters when Caps Lock is On ====
 
631
When enabled, a warning beep will be heard if a letter is typed with the shift key while caps lock is on.
 
632
Generally, typing shifted letters with caps lock is unintentional and is usually due to not realising that caps lock is enabled.
 
633
Therefore, it can be quite helpful to be warned about this.
 
634
 
 
635
%kc:setting
387
636
==== Speak Command Keys ====
388
 
A checkbox that when checked means that NVDA will announce all non-character keys you type on the keyboard. This includes key combinations such as control plus another letter. You can also configure this option from anywhere by pressing NVDA+4.
389
 
 
390
 
+++ Mouse Settings +++
391
 
The Mouse Settings dialog is found in the Preferences Menu, under "Mouse settings...". Alternatively, it can be accessed by pressing NVDA+Control+M. It contains the following options:
 
637
Key: NVDA+4
 
638
 
 
639
When enabled, NVDA will announce all non-character keys you type on the keyboard. This includes key combinations such as control plus another letter.
 
640
 
 
641
+++ Mouse Settings (NVDA+control+m) +++[MouseSettings]
 
642
The Mouse Settings dialog is found in the Preferences Menu, under "Mouse settings...".
 
643
It contains the following options:
392
644
 
393
645
==== Report Mouse Shape Changes ====
394
 
A checkbox, that when checked means that NVDA will announce the shape of the mouse pointer each time it changes. The mouse pointer in Windows changes shape to convey certain information such as when something is editable, or when something is loading etc.
395
 
 
396
 
==== Report text Under Mouse ====
397
 
A checkbox that when checked means that NVDA will announce the text currently under the mouse pointer, as you move it around the screen. This allows you to find things on the screen, by physically moving the mouse, rather than trying to find them through object navigation.
 
646
A checkbox, that when checked means that NVDA will announce the shape of the mouse pointer each time it changes.
 
647
The mouse pointer in Windows changes shape to convey certain information such as when something is editable, or when something is loading etc.
 
648
 
 
649
%kc:setting
 
650
==== Enable mouse tracking ====
 
651
| Desktop key | NVDA+m |
 
652
| Laptop key | NVDA+shift+m |
 
653
 
 
654
When enabled, NVDA will announce the text currently under the mouse pointer, as you move it around the screen. This allows you to find things on the screen, by physically moving the mouse, rather than trying to find them through object navigation.
398
655
 
399
656
==== Text unit resolution ====
400
 
If NVDA is set to announce the text under the mouse as you move it, this option allows you to choose exactly how much text will be spoken. The options are character, word, line and paragraph.
 
657
If NVDA is set to announce the text under the mouse as you move it, this option allows you to choose exactly how much text will be spoken.
 
658
The options are character, word, line and paragraph.
401
659
 
402
660
==== Report role when mouse enters object ====
403
661
If this checkbox is checked, NVDA will announce the role (type) of object as the mouse moves in side it.
404
662
 
405
663
==== Play audio coordinates when mouse moves ====
406
 
Checking this checkbox makes NVDA play beeps as the mouse moves, so that the user can work out where the mouse is in regards to the dimentions of the screen.
 
664
Checking this checkbox makes NVDA play beeps as the mouse moves, so that the user can work out where the mouse is in regards to the dimensions of the screen.
407
665
 
408
666
==== Brightness controls audio coordinates volume ====
409
 
If the 'play audio coordinates when mouse moves' checkbox is checked, then checking this checkbox means that the volume of the audio coordinates beeps is controled by how bright the screen is under the mouse. This may cause some performence issues on Windows Vista, so it is unchecked by default.
410
 
 
411
 
+++ Object Presentation Settings +++
412
 
Found in the Preferences menu under "Object Presentation..." or by pressing NVDA+Control+O. This dialog box contains the following options:
 
667
If the 'play audio coordinates when mouse moves' checkbox is checked, then checking this checkbox means that the volume of the audio coordinates beeps is controled by how bright the screen is under the mouse.
 
668
This  setting is unchecked by default.
 
669
 
 
670
+++ Review Cursor settings +++
 
671
Found in the Preferences menu under Review Cursor...
 
672
This dialog contains the following options:
 
673
 
 
674
%kc:setting
 
675
==== Follow System Focus ====
 
676
| Desktop key | NVDA+7 |
 
677
| Laptop key | NVDA+control+7 |
 
678
 
 
679
When enabled, The review cursor will always be placed in the same object as the current system focus as it changes.
 
680
 
 
681
%kc:setting
 
682
==== Follow System Caret ====
 
683
Key: NVDA+6
 
684
 
 
685
When enabled, the review cursor will automatically be moved to the position of the System caret each time it moves.
 
686
 
 
687
==== Follow mouse ====
 
688
When enabled, the review cursor will follow the mouse as it moves.
 
689
 
 
690
==== Simple Review mode ====
 
691
When enabled, NVDA will filter the hierarchy of objects that can be navigated, to exclude any unusable objects.
 
692
 
 
693
+++ Object Presentation Settings (NVDA+control+o) +++
 
694
Found in the Preferences menu under "Object Presentation...".
 
695
This dialog box contains the following options:
413
696
 
414
697
==== Report Tool Tips ====
415
 
A checkbox that when checked tells NVDA to announce tool tips as they appear. Many Windows and controls show a small message (or tool tip) when you move the mouse pointer over them, or sometimes when you move the focus to them.
 
698
A checkbox that when checked tells NVDA to announce tool tips as they appear.
 
699
Many Windows and controls show a small message (or tool tip) when you move the mouse pointer over them, or sometimes when you move the focus to them.
416
700
 
417
701
==== Report Help Balloons ====
418
 
This checkbox when checked tells NVDA to announce help balloons as they appear. Help Balloons are like tool tips, but are usually larger in size, and are associated with system events such as a network cable being unplugged, or perhaps to alert you about Windows security issues.
 
702
This checkbox when checked tells NVDA to announce help balloons as they appear.
 
703
Help Balloons are like tool tips, but are usually larger in size, and are associated with system events such as a network cable being unplugged, or perhaps to alert you about Windows security issues.
419
704
 
420
705
==== Report Object Shortcut Keys ====
421
 
When this checkbox is checked, NVDA will include the shortcut key that is associated with a certain object or control when it is announced. For example the File menu on a menu bar may have a shortcut key of alt+f.
 
706
When this checkbox is checked, NVDA will include the shortcut key that is associated with a certain object or control when it is announced.
 
707
For example the File menu on a menu bar may have a shortcut key of alt+f.
422
708
 
423
709
==== Report object position information ====
424
710
This option lets you choose whether you wish to have an object's position (e.g. 1 of 4) reported when moving to the object with the focus or object navigation.
425
711
 
 
712
==== Guess Object Position Information when unavailable ====
 
713
If reporting of object position information is turned on, this option allows NVDA to guess object position information when it is otherwize unavailable for a particular control.
 
714
 
 
715
When on, NVDA will announce position information for more controls such as menus and toolbars, however this information may be slightly inaccurate.
 
716
 
426
717
==== Report Object descriptions ====
427
718
Uncheck this checkbox if you feel you don't need to hear the description announced along with objects.
428
719
 
 
720
%kc:setting
429
721
==== Progress bar output ====
430
 
A progress bar is a control which looks a bit like a ruler. As a task is slowly being completed, more of the bar gets highlighted. It also shows a percentage value, to numerically tell you how far along it is. Progress bars are shown for things like loading a web page, checking your email, or processing a sound file etc.
431
 
 
432
 
This option presents you with a combo box which controls how nvda reports progress bar updates to you. It has the following options:
 
722
| Desktop key | NVDA+u |
 
723
| Laptop key | NVDA+control+f2 |
 
724
 
 
725
This option   controls how nvda reports progress bar updates to you.
 
726
 
 
727
It has the following options:
433
728
- Off: Progress bars will not be reported as they change.
434
729
- Speak: This option tells nvda to speak the progress bar in percentages. Each time the progress bar changes, nvda will speak the new value.
435
730
- Beep: This tells nvda to beep each time the progress bar changes. The higher the beep, the closer the progress bar is to completion.
437
732
-
438
733
 
439
734
==== Report background progress bars ====
440
 
This is an option that, when checked, tells nvda to keep reporting a progress bar, even if it is not physically in the foreground. If you minimize or switch away from a window that contains a progress bar, nvda will keep track of it, allowing you to do other things while nvda tracks the progress bar.
441
 
 
442
 
+++ Virtual Buffer Settings +++
443
 
The Virtual Buffer settings dialog can be found in the Preferences menu, under "Virtual Buffers...". Alternatively, it can be accessed by pressing NVDA+Control+B.
 
735
This is an option that, when checked, tells nvda to keep reporting a progress bar, even if it is not physically in the foreground.
 
736
If you minimize or switch away from a window that contains a progress bar, nvda will keep track of it, allowing you to do other things while nvda tracks the progress bar.
 
737
 
 
738
%kc:setting
 
739
==== Report dynamic content changes ====
 
740
Key: NVDA+5
 
741
 
 
742
Toggles the announcement of new content in particular objects such as terminals and the history control in chat programs.
 
743
 
 
744
+++ Browse Mode Settings (NVDA+control+b) +++
 
745
The Browse Mode settings dialog can be found in the Preferences menu, under "Browse mode...".
444
746
 
445
747
The dialog contains the following options:
446
748
 
447
749
==== Maximum Number of Characters on One Line ====
448
 
This field sets the maximum length of a line of a virtual buffer (in characters).
 
750
This field sets the maximum length of a line in browse mode (in characters).
449
751
 
450
752
==== Maximum Lines Per Page ====
451
 
Although virtual buffers don't really have pages, this field sets the amount of lines you will move by when pressing page up or page down while in a virtual buffer.
 
753
This field sets the amount of lines you will move by when pressing page up or page down while in browse mode.
452
754
 
 
755
%kc:setting
453
756
==== Use screen layout ====
454
 
This option allows you to specify whether content in the virtual Buffer should place content such as links and other fields on their own line, or if it should keep them in the flow of text as it is visually shown. If the option is enabled then things will stay as they are visually shown, but if it is disabled then fields will be placed on their own line.
 
757
Key: NVDA+v
 
758
 
 
759
This option allows you to specify whether content in browse mode should place content such as links and other fields on their own line, or if it should keep them in the flow of text as it is visually shown. If the option is enabled then things will stay as they are visually shown, but if it is disabled then fields will be placed on their own line.
 
760
 
 
761
==== Automatic Say All on page load ====
 
762
This checkbox toggles the automatic reading of a page after it loads in browse mode.
 
763
This option is enabled by default.
455
764
 
456
765
==== Report layout tables ====
457
 
When disabled this option makes NVDA only report tables that contain tabular data (where it makes sense to know that this is a table). But if enabled, NVDA will also report tables used purely for visual presentation.
 
766
When disabled this option makes NVDA only report tables that contain tabular data (where it makes sense to know that this is a table).
 
767
But if enabled, NVDA will also report tables used purely for visual presentation.
458
768
 
459
769
==== Configuring announcement of fields such as links and headings ====
460
 
Previous versions of NVDA allowed you to use the Virtual Buffer settings dialog to configure whether NVDA should announce the type of field that you entered while reading through web content. Examples of field types are links, headings, tables, and lists. To configure these, please find new options in the [Document Formatting Settings dialog #DocumentFormattingSettings]. These options now not only affect virtual Buffers, but any documents that may cause these types of fields to be announced.
 
770
Please see the options in the [Document Formatting Settings dialog #DocumentFormattingSettings] to configure the fields that are spoken when navigating, such as links, headings and tables.
461
771
 
462
772
==== Automatic focus mode for focus changes ====
463
 
This option allows focus mode to be invoked if focus changes. For example, when on a web page, if you press tab and you land on a form, if this option is checked, focus mode will automatically be invoked.
 
773
This option allows focus mode to be invoked if focus changes.
 
774
For example, when on a web page, if you press tab and you land on a form, if this option is checked, focus mode will automatically be invoked.
464
775
 
465
 
==== Automatic focus mode for carret movement ====
466
 
This option, when checked, allows NVDA to enter and leave focus mode when using arrow keys. For example, if arrowing down a webpage and you land on an edit box, NVDA will automatically bring you into focus mode. If you arrow out of the edit box, NVDA will put you back in browse mode.
 
776
==== Automatic focus mode for caret movement ====
 
777
This option, when checked, allows NVDA to enter and leave focus mode when using arrow keys.
 
778
For example, if arrowing down a webpage and you land on an edit box, NVDA will automatically bring you into focus mode. If you arrow out of the edit box, NVDA will put you back in browse mode.
467
779
 
468
780
==== Audio indication of Focus and Browse modes ====
469
 
If this option is enabled, NVDA will play special sounds when it switches between browse mode and focus mode in a virtual Buffer, rather than speaking the change.
470
 
 
471
 
+++ Document Formatting Settings +++[DocumentFormattingSettings]
472
 
This dialog box is found in the Preferences menu, under "Document Formatting...". Alternatively, this dialog box can be invoked by pressing NVDA+Control+D. All the checkboxes in this dialog are for configuring what type of formatting you wish to hear automatically as you move the cursor around microsoft word or wordpad documents. For example, if you check the report font name checkbox, each time you arrow onto text with a different font, the name of the font will be announced.
473
 
 
474
 
You can configure announcement of font name, font size, font attributes, style, text alignment, text style, tables, page numbers, line numbers, spelling errors, links, headings, lists and blockquotes.
 
781
If this option is enabled, NVDA will play special sounds when it switches between browse mode and focus mode, rather than speaking the change.
 
782
 
 
783
+++ Document Formatting Settings (NVDA+control+d) +++[DocumentFormattingSettings]
 
784
This dialog box is found in the Preferences menu, under "Document Formatting...".
 
785
 
 
786
Most of the checkboxes in this dialog are for configuring what type of formatting you wish to hear automatically as you move the cursor around documents.
 
787
For example, if you check the report font name checkbox, each time you arrow onto text with a different font, the name of the font will be announced.
 
788
 
 
789
You can configure announcement of:
 
790
- font name
 
791
- font size
 
792
- font attributes
 
793
- text alignment
 
794
- Colors
 
795
- text style
 
796
- spelling errors
 
797
- page numbers
 
798
- line numbers
 
799
- tables
 
800
- table row/column headers
 
801
- table cell coordinates
 
802
- links
 
803
- headings
 
804
- lists
 
805
- blockquotes
 
806
- Landmarks
 
807
-
 
808
 
 
809
==== Announce formatting changes after the cursor ====
 
810
If enabled, this setting tells NVDA to try and detect all the formatting changes on a line as it speaks it, even if doing this may slow down NVDA's performance.
 
811
 
 
812
By default, NVDA will detect the formatting at the position of the System caret / Review Cursor, and in some instances may detect formatting on the rest of the line, only if it is not going to cause a performance decrease.
 
813
 
 
814
Enable this option while  proof reading documents in applications such as Microsoft Word, where formatting is important.
475
815
 
476
816
+++ Speech dictionaries +++
477
 
The speech dictionaries menu (found in the Preferences menu) contains dialogs that allow you to manage the way NVDA pronounces particular words or phrases. There are currently three different types of speech dictionaries. They are:
 
817
The speech dictionaries menu (found in the Preferences menu) contains dialogs that allow you to manage the way NVDA pronounces particular words or phrases.
 
818
There are currently three different types of speech dictionaries.
 
819
They are:
478
820
- Default: rules in this dictionary affect all speech in NVDA.
479
821
- Voice: rules in this dictionary affect speech for the synthesizer voice currently being used.
480
822
- Temporary: rules in this dictionary affect all speech in NVDA, but only for the current session. These rules are temporary and will be lost if NVDA is restarted.
481
823
-
482
824
 
483
 
All dictionary dialogs contain a list of rules which will be used for processing the speech. The dialog also contains Add, Edit and remove buttons.
484
 
 
485
 
To add a new rule to the dictionary, press the Add button, and fill in the fields in the dialog box that appears and then press Ok. You will then see your new rule in the list of rules. However to make sure your rule is actually saved, make sure to press Ok to exit the dictionary dialog all together once you have finished adding/editing rules.
486
 
 
487
 
The rules for NVDA's speech dictionaries allow you to change one string of characters in to another. A simple example would be that you want to have NVDA say the word frog each time it is supposed to say the word bird. In the Add rule dialog, the easiest way to do this is to type the word bird in the Pattern field, and the word frog in the Replacement field. You may also want to type a description of the rule in the Comment field (something like: changes bird to frog).
488
 
 
489
 
NVDA's speech dictionaries however are much more powerful than simple word replacement. The Add rule dialog also contains a checkbox to say whether or not you want the rule to be case sensitive (meaning that NVDA should care whether the characters are uppercase or lowercase. NVDA ignores case by default). Another chekbox allows you to state whether your pattern is a "Regular expression". A regular expression is a pattern containing special symbols that allow you to match on more than one character at a time, or match on just numbers, or just letters, as a few examples. Regular expressions are not covered in this user guide, but there are many tutorials on the web which can provide you with more information.
490
 
 
491
 
+++ Saving and Reloading the configuration +++
492
 
NVDA stores its settings in a file called nvda.ini in its directory. You will probably never have to touch this file, but for advanced users, this file does allow you to change some extra settings which don't yet have dialog boxes to do so.
493
 
 
494
 
NVDA does not automatically save your settings, so if you exit NVDA, and then restart it, the settings will go back to the original values. Note, however, that this default option can be changed under the general options in the preferences menu. To save the settings, you can either choose the Save configuration item in the NVDA menu, or press NVDA+Control+c from anywhere.
 
825
All dictionary dialogs contain a list of rules which will be used for processing the speech.
 
826
The dialog also contains Add, Edit and remove buttons.
 
827
 
 
828
To add a new rule to the dictionary, press the Add button, and fill in the fields in the dialog box that appears and then press Ok.
 
829
You will then see your new rule in the list of rules.
 
830
However to make sure your rule is actually saved, make sure to press Ok to exit the dictionary dialog all together once you have finished adding/editing rules.
 
831
 
 
832
The rules for NVDA's speech dictionaries allow you to change one string of characters into another.
 
833
A simple example would be that you want to have NVDA say the word frog each time it is supposed to say the word bird.
 
834
In the Add rule dialog, the easiest way to do this is to type the word bird in the Pattern field, and the word frog in the Replacement field.
 
835
You may also want to type a description of the rule in the Comment field (something like: changes bird to frog).
 
836
 
 
837
NVDA's speech dictionaries however are much more powerful than simple word replacement.
 
838
The Add rule dialog also contains a checkbox to say whether or not you want the rule to be case sensitive (meaning that NVDA should care whether the characters are uppercase or lowercase.
 
839
NVDA ignores case by default).
 
840
Another chekbox allows you to state whether your pattern is a "Regular expression".
 
841
A regular expression is a pattern containing special symbols that allow you to match on more than one character at a time, or match on just numbers, or just letters, as a few examples.
 
842
Regular expressions are not covered in this user guide, but there are many tutorials on the web which can provide you with more information.
 
843
 
 
844
+++ Punctuation/symbol pronunciation +++[SymbolPronunciation]
 
845
This dialog allows you to change the way punctuation and other symbols are pronounced, as well as the symbol level at which they are spoken.
 
846
 
 
847
To change a symbol, first select it in the Symbols list.
 
848
The Replacement field allows you to change the text that should be spoken in place of this symbol.
 
849
Using the Level field, you can adjust the lowest symbol level at which this symbol should be spoken.
 
850
 
 
851
When you are finished, press the OK button to save your changes or the Cancel button to discard them.
 
852
 
 
853
By default NVDA does not automatically save your settings, so if you exit NVDA, and then restart it, the settings will go back to the original values.
 
854
Note, however, that this  option can be changed under the general options in the preferences menu.
 
855
To save the settings,  choose the Save configuration item in the NVDA menu.
495
856
 
496
857
If NVDA is on a read-only file system, such as a CD, it will not be able to save your settings, and it will tell you so.
497
858
 
498
 
If you ever make a mistake with your settings and need to revert back to the saved settings, you can either choose the "revert to saved configuration" item in the NVDA menu, or you can press NVDA+Control+r from anywhere.
499
 
 
500
 
+ Troubleshooting NVDA +
501
 
As NVDA is constantly being updated, there is no guarantee that all commands provided here in this user guide will still apply. If you have any problems with any of the commands presented in this user guide, please visit: NVDA_URL for more assistance.
 
859
If you ever make a mistake with your settings and need to revert back to the saved settings,  choose the "revert to saved configuration" item in the NVDA menu.
 
860
 
 
861
The following NVDA key commands are also useful:
 
862
%kc:beginInclude
 
863
|| Name | Desktop key | Laptop key | Description |
 
864
| Save configuration | NVDA+control+c | NVDA+control+c | Saves your current configuration so that it is not lost when you exit NVDA |
 
865
| Revert to saved configuration | NVDA+control+r | NVDA+control+r | Restores NVDA to the settings that existed when you last saved NVDA's configuration |
 
866
%kc:endInclude
 
867
 
 
868
Portable versions of NVDA store all settings,  custom appModules and custom drivers in a directory called userConfig, found in the NVDA directory.
 
869
 
 
870
Installed versions of NVDA store all settings, custom appModules and custom drivers in a special NVDA directory located in your Windows user profile.
 
871
This means that each user on the system can have their own NVDA settings.
 
872
To get to your settings directory for an installed version of NVDA, on the start menu you can go to programs -> NVDA -> explore user configuration directory.
 
873
 
 
874
Settings for NVDA when running on the logon or UAC screens is stored in the systemConfig directory in NVDA's installation directory.
 
875
Usually this configuration should not be touched.
 
876
To change how NVDA is configured on the logon/UAC screens, configure NVDA to how you wish  while logged into Windows, and then instruct NVDA to copy the configuration to the logon screen by using the button in the General settings dialog.
 
877
 
 
878
+ Extra Tools +
 
879
 
 
880
The log viewer, found under Tools in the NVDA menu, allows you to view all the logging output that has occured up until now from when you last started NVDA.
 
881
 
 
882
Apart from reading the content, you can also Save a copy of the log file, or refresh the viewer so that it shows the most recent output since the Log viewer was opened.
 
883
These actions are available under the viewer's Log menu.
 
884
 
 
885
For sighted software developers or people demoing NVDA to sighted audiences, a floating window is available that allows you to  view all the text that NVDA is currently speaking.
 
886
 
 
887
To enable the speech viewer, check  the "Speech Viewer" menu item under Tools in the NVDA menu.
 
888
Uncheck the menu item to disable it.
 
889
 
 
890
While the speech viewer is enabled, it constantly updates to show you the most current text being spoken.
 
891
However, if you click or focus inside the viewer, NVDA will temporarily stop updating the text, so that you are able to easily select or copy the existing content.
 
892
 
 
893
The NVDA Python console, found under  Tools in the NVDA menu, is a development tool which is useful for debugging, general inspection of NVDA internals or inspection of the accessibility hierarchy of an application.
 
894
For more information, please see the Developer Guide available from [the Development section of the NVDA web site NVDA_URLwiki/Development].
 
895
 
 
896
This item, once activated, reloads app modules and global plugins without restarting NVDA, which can be useful for developers.
 
897
 
 
898
+ Supported Speech Synthesizers +[SupportedSpeechSynths]
 
899
This section contains information about the speech synthesizers  supported by NVDA.
 
900
 
 
901
The [eSpeak http://espeak.sourceforge.net/] synthesizer is built directly into NVDA and does not require any other special drivers or components to be installed.
 
902
NVDA starts using eSpeak by default.
 
903
As this synthesizer is built into NVDA, this is a great choice for when running NVDA off a USB thumb drive or CD on other systems.
 
904
 
 
905
Each voice that comes with eSpeak speaks a different language.
 
906
There are over 20 different languages supported by eSpeak.
 
907
 
 
908
There are also many variants which can be chosen to alter the sound of the voice.
 
909
 
 
910
SAPI 4 is an older Microsoft standard for software speech synthesizers.
 
911
Many speech synthesizers that comply with this standard may be  purchased or downloaded for free from various companies and websites.
 
912
When using this synthesizer with NVDA, the available voices (accessed from the [Voice Settings dialog #VoiceSettings] or by the [Synth Settins Ring #SynthSettingsRing]) will contain all the voices from all the installed SAPI 4 engines found on your system.
 
913
 
 
914
If you have SAPI 4 voices installed but the synthesizer does not appear in NVDA's list of synthesizers, please install the SAPI 4.0 runtime binaries, available at http://activex.microsoft.com/activex/controls/sapi/spchapi.exe.
 
915
 
 
916
SAPI 5 is a Microsoft standard for software speech synthesizers.
 
917
Many speech synthesizers that comply with this standard may be  purchased or downloaded for free from various companies and websites, though your system will probably already come with at least one SAPI 5 voice preinstalled.
 
918
When using this synthesizer with NVDA, the available voices (accessed from the [Voice Settings dialog #VoiceSettings] or by the [Synth Settins Ring #SynthSettingsRing]) will contain all the voices from all the installed SAPI 5 engines found on your system.
 
919
 
 
920
The Microsoft Speech Platform provides voices for many languages which are normally used in the development of server-based speech applications.
 
921
These voices can also be used with NVDA.
 
922
 
 
923
To use these voices, you will need to install two components:
 
924
- Microsoft Speech Platform - Server Runtime (Version 10.2), x86: http://www.microsoft.com/download/en/details.aspx?id=10208
 
925
- Microsoft Speech Platform - Server Runtime Languages (Version 10.2): http://www.microsoft.com/download/en/details.aspx?id=21924
 
926
-
 
927
 
 
928
This is a commercial speech synthesizer specifically for the Italian language.
 
929
You must have the synthesizer installed on your system in order for it to be used with NVDA.
 
930
For more information, please visit the Audiologic website at www.audiologic.it.
 
931
 
 
932
This synthesizer does not support [spelling functionality #VoiceSpellingFunctionality].
 
933
 
 
934
Newfon is a free commercial synthesizer by Sergey Shishmintzev which supports the Russian and Ukrainian languages.
 
935
To download this synthesizer, please visit the downloads section of the Russian NVDA community site: http://ru.nvda-community.org/?page_id=10
 
936
 
 
937
This synthesizer does not support [spelling functionality #VoiceSpellingFunctionality].
 
938
 
 
939
+ Supported Braille Displays +[SupportedBrailleDisplays]
 
940
This section contains information about the Braille displays supported by NVDA.
 
941
 
 
942
All Focus and PAC Mate displays from [Freedom Scientific http://www.freedomscientific.com/] are supported when connected via USB or bluetooth.
 
943
You will need the Freedom Scientific braille display drivers installed on your system.
 
944
If you do not have them already, you can obtain them from http://www.freedomscientific.com/downloads/focus-40-blue/focus-40-blue-downloads.asp.
 
945
Although this page only mentions the Focus 40 Blue display, the drivers support all Freedom Scientific displays.
 
946
If your system is running 64 bit Windows and the drivers were already installed by another screen reader, you will probably still need to install the drivers from this link, as the files required by NVDA were probably not installed by the other screen reader.
 
947
 
 
948
Following are the key assignments for this display with NVDA.
 
949
Please see the display's documentation for descriptions of where these keys can be found.
 
950
%kc:beginInclude
 
951
|| Name | Key |
 
952
| Toggle left wiz wheel action | leftWizWheelPress |
 
953
| Move back using left wiz wheel action | leftWizWheelUp |
 
954
| Move forward using left wiz wheel action | leftWizWheelDown |
 
955
| Toggle right wiz wheel action | rightWizWheelPress |
 
956
| Move back using right wiz wheel action | rightWizWheelUp |
 
957
| Move forward using right wiz wheel action | rightWizWheelDown |
 
958
| Route to braille cell | routing |
 
959
%kc:endInclude
 
960
 
 
961
Both the ALVA BC640 and BC680 displays from [Optelec http://www.optelec.com/] are supported when connected via USB or bluetooth.
 
962
You do not need any specific drivers to be installed to use these displays.
 
963
Just plug in the display and configure NVDA to use it.
 
964
 
 
965
Following are the key assignments for this display with NVDA.
 
966
Please see the display's documentation for descriptions of where these keys can be found.
 
967
%kc:beginInclude
 
968
|| Name | Key |
 
969
| Scroll braille display back | t1 |
 
970
| Move braille display to previous line | t2 |
 
971
| Move braille display to next line | t4 |
 
972
| Scroll braille display forward | t5 |
 
973
| Route to braille cell | routing |
 
974
| shift+tab key | sp1 |
 
975
| alt key | sp2 |
 
976
| escape key | sp3 |
 
977
| tab key | sp4 |
 
978
| upArrow key | spUp |
 
979
| downArrow key | spDown |
 
980
| leftArrow key | spLeft |
 
981
| rightArrow key | spRight |
 
982
| enter key | spEnter |
 
983
| NVDA Menu | sp1+sp3 |
 
984
| windows+d key (minimise all applications) | sp1+sp4 |
 
985
| windows key | sp2+sp3 |
 
986
| alt+tab key | sp2+sp4 |
 
987
%kc:endInclude
 
988
 
 
989
NVDA supports all displays from [Handy Tech http://www.handytech.de/] when connected via USB or bluetooth.
 
990
For older USB displays, you will need to install the USB drivers from Handy Tech on your system.
 
991
 
 
992
Following are the key assignments for this display with NVDA.
 
993
Please see the display's documentation for descriptions of where these keys can be found.
 
994
%kc:beginInclude
 
995
|| Name | Key |
 
996
| Scroll braille display back | left, up |
 
997
| Scroll braille display forward | right, down |
 
998
| Move braille display to previous line | b4 |
 
999
| Move braille display to next line | b5 |
 
1000
| Route to braille cell | routing |
 
1001
| shift+tab key | esc |
 
1002
| alt key | b2+b4+b5 |
 
1003
| escape key | b4+b6 |
 
1004
| tab key | enter |
 
1005
| enter key | esc+enter |
 
1006
| upArrow key | leftSpace |
 
1007
| downArrow key | rightSpace |
 
1008
| NVDA Menu | b2+b4+b5+b6 |
 
1009
| Handy Tech configuration | b4+b8 |
 
1010
%kc:endInclude
 
1011
 
 
1012
The Lilli braille display available from [MDV http://www.mdvbologna.it/] is supported.
 
1013
You do not need any specific drivers to be installed to use this display.
 
1014
Just plug in the display and configure NVDA to use it.
 
1015
 
 
1016
Following are the key assignments for this display with NVDA.
 
1017
Please see the display's documentation for descriptions of where these keys can be found.
 
1018
%kc:beginInclude
 
1019
|| Name | Key |
 
1020
| Scroll braille display backward | LF |
 
1021
| Scroll braille display forward | RG |
 
1022
| Move braille display to previous line | UP |
 
1023
| Move braille display to next line | DN |
 
1024
| Route to braille cell | route |
 
1025
| shift+tab key | SLF |
 
1026
| tab key | SRG |
 
1027
| alt+tab key | SDN |
 
1028
| alt+shift+tab key | SUP |
 
1029
%kc:endInclude
 
1030
 
 
1031
Several [Baum http://www.baum.de/cms/en/], [HumanWare http://www.humanware.com/] and [APH http://www.aph.org/] displays are supported when connected via USB or bluetooth.
 
1032
These include:
 
1033
- Baum: SuperVario, PocketVario
 
1034
- HumanWare: Brailliant, BrailleConnect
 
1035
- APH: Refreshabraille
 
1036
-
 
1037
Some other displays manufactured by Baum may also work, though this has not been tested.
 
1038
 
 
1039
If connecting via USB, you must first install the USB drivers provided by the manufacturer.
 
1040
For the APH Refreshabraille, the USB mode must be set to serial.
 
1041
 
 
1042
Following are the key assignments for this display with NVDA.
 
1043
Please see the display's documentation for descriptions of where these keys can be found.
 
1044
%kc:beginInclude
 
1045
|| Name | Key |
 
1046
| Scroll braille display back | d2 |
 
1047
| Scroll braille display forward | d5 |
 
1048
| Move braille display to previous line | d1 |
 
1049
| Move braille display to next line | d3 |
 
1050
| Route to braille cell | routing |
 
1051
 
 
1052
For displays which have a joystick:
 
1053
|| Name | Key |
 
1054
| upArrow key | up |
 
1055
| downArrow key | down |
 
1056
| leftArrow key | left |
 
1057
| rightArrow key | right |
 
1058
| enter key | select |
 
1059
%kc:endInclude
 
1060
 
 
1061
[BRLTTY http://mielke.cc/brltty/] is a separate program which can be used to support many more braille displays.
 
1062
In order to use this, you need to install [BRLTTY for Windows http://brl.thefreecat.org/brltty/].
 
1063
You should download and install the latest installer package, which will be named, for example, brltty-win-4.2-2.exe.
 
1064
When configuring the display and port to use, be sure to pay close attention to the instructions, especially if you are using a USB display and already have the manufacturer's drivers installed.
 
1065
 
 
1066
Following are the BRLTTY command assignments for NVDA.
 
1067
Please see the [BRLTTY key tables documentation http://mielke.cc/brltty/doc/drivers/] for information about how BRLTTY commands are mapped to controls on braille displays.
 
1068
%kc:beginInclude
 
1069
|| Name | BRLTTY command |
 
1070
| Scroll braille display back | fwinlt (go left one window) |
 
1071
| Scroll braille display forward | fwinrt (go right one window) |
 
1072
| Move braille display to previous line | lnup (go up one line) |
 
1073
| Move braille display to next line | lndn (go down one line) |
 
1074
| Route to braille cell | route (bring cursor to character) |
 
1075
%kc:endInclude
 
1076
 
 
1077
+ Advanced Topics +
 
1078
 
 
1079
Users are able to provide or override mappings of input gestures (such as key presses) to scripts in a special file in the user's NVDA configuration directory.
 
1080
This file is called gestures.ini.
 
1081
 
 
1082
This file uses standard ini syntax.
 
1083
The file may contain multiple sections and each section may have one or more entries.
 
1084
 
 
1085
Each section provides mappings for scripts in a particular Python module and class inside NVDA.
 
1086
- The section name should be the Python module and class separated by a dot (.).
 
1087
- The key of each entry is the name of the script to which input gestures should be bound.
 
1088
Alternatively, you can use None to unbind input gestures from a script to which they were previously bound.
 
1089
Each entry key can only be listed once per section, including None.
 
1090
- The entry value is a comma (,) separated list of gesture identifiers for the input gestures that should be bound.
 
1091
Gesture identifiers ending in a comma must be enclosed in quotes (" or ').
 
1092
-
 
1093
 
 
1094
Gesture identifiers consist of a two leter device code (kb for keyboard and br for braille display), an optional sub-device or keyboard layout in brackets, a colon, and then one or more key names separated by a plus (+) sign.
 
1095
 
 
1096
In order to discover gesture identifiers, script names and the class and module in which they are contained, you can:
 
1097
+ Turn on Input Help.
 
1098
+ Activate the gesture (press the key).
 
1099
+ Turn off input help.
 
1100
+ Activate View log in the NVDA Tools menu.
 
1101
+ Examine the recent log entries.
 
1102
One of these should provide information about the input gesture you sent, including the module.class and script if it is bound to one.
 
1103
+
 
1104
 
 
1105
Following is an example of how you could bind NVDA+shift+t to the date time script.
 
1106
 
 
1107
To find out the correct script name and module.class for date time, you would turn on Input Help and press NVDA+f12 (as this is the current gesture for the date time script).
 
1108
You would then turn off Input Help and examine the log viewer.
 
1109
 
 
1110
Towards the bottom, you would see:
 
1111
 
 
1112
```
 
1113
INFO - inputCore.InputManager._handleInputHelp (13:17:22):
 
1114
Input help: gesture kb(desktop):nvda+f12, bound to script dateTime on globalCommands.GlobalCommands
 
1115
```
 
1116
 
 
1117
From this, you can see that the script name is dateTime and the module.class is globalCommands.GlobalCommands.
 
1118
 
 
1119
If the file does not yet exist, you would create a text file called gestures.ini in the user configuration directory and add the following content:
 
1120
 
 
1121
```
 
1122
[globalCommands.GlobalCommands]
 
1123
        dateTime = kb:NVDA+shift+t
 
1124
```
 
1125
 
 
1126
This would bind the key press NVDA+shift+t (in any keyboard layout) to the dateTime script.
 
1127
 
 
1128
Note that the original NVDA+f12 binding would still work.
 
1129
If you wanted to remove this binding, you would add the following line:
 
1130
 
 
1131
```
 
1132
        None = kb:NVDA+f12
 
1133
```
 
1134
 
 
1135
Although you are free to have scripts bound to any available key, it may be problematic to use the alt key on the keyboard.
 
1136
NVDA still sends modifier keys (such as shift, control and alt) to the Operating System, even if they eventuate in a script.
 
1137
Thus, if you do use alt in a gesture, pressing this key combination may activate the menu bar, as well as executing the script.
 
1138
Therefore, it is probably best to just use Shift, control and the NVDA modifier key as modifiers.
 
1139
 
 
1140
It is possible to customize the pronunciation of punctuation and other symbols beyond what can be done using the [Punctuation/symbol pronunciation #SymbolPronunciation] dialog.
 
1141
For example, you can specify whether the raw symbol should be sent to the synthesizer (e.g. to cause a pause or change in inflection) and you can add custom symbols.
 
1142
 
 
1143
To do this, you must edit the symbol pronunciation information file in your NVDA user configuration directory.
 
1144
The file is called symbols-xx.dic, where xx is the language code.
 
1145
The format of this file is documented in the Symbol Pronunciation section of the NVDA Developer Guide, which is available from [the Development section of the NVDA web site NVDA_URLwiki/Development].
 
1146
However, it is not possible for users to define complex symbols.
 
1147
 
 
1148
+ Further Information +
 
1149
If you require further information or assistance regarding NVDA, please visit the NVDA web site at NVDA_URL.
 
1150
Here, you can find additional documentation, as well as technical support and community resources.
 
1151
This site also provides information and resources concerning NVDA development.