GitHub repository: https://github.com/paulber19/NVDAExtensionGlobalPlugin.git
Download:
Compatibility:
Traductor (s): based on automatic translation from french language
on going redaction
This add-on adds to NVDA's global commands:
In NVDA's "Preferences" sub-menu, the "NVDA global commands extension" sub-menu has been added which offers the following choices, depending on the case:
Apart from the last menu, each is associated with a script without a input gesture allowing it to be activated. With the dialog "gestures of commands" of NVDA it is possible to assign them one.
These are the following scripts with their interpreter command:
This configuration is saved in two ways depending on the functionality or option concerned:
NVDA offers the option "Save configuration on exiting" (see NVDA user manual) which allows to automatically save NVDA configuration when exiting or restarting NVDA. If this option is not checked, the configuration is only saved upon user action or upon modification of a parameter that requires restarting NVDA.
This add-on follows this mode of operation.
Some add-on setting changes require saving the configuration and restarting NVDA. In this case, the user is offered to save and immediately restart as NVDA does when there is a change of language.
When uninstalling the add-on, its configuration file is deleted and the add-on's configuration is cleared from all configuration profiles.
When uninstalling a feature, its configuration, if any, is completely deleted.
In the case of an update, installing the add-on offers the possibility of keeping (as far as possible) or not the previous configuration.
Using the "Reset configuration" submenu, it is possible to restore the configuration to the same state as when the add-on was first installed, including the one saved in the configuration profiles.
This allows you to start from scratch without having to uninstall and reinstall the add-on in case of possible problems.
In most of the extension's dialogs, it is possible using the "F1" key to open the extension user manual to the most appropriate chapter.
The update of the add-on is, by default, automatically a short time after the start of NVDA (between 20 and 600 seconds) and a maximum of once per day. It is possible to disable this update by unchecking the option "automatically check for updates" of "Update" category in the add-on's settings. The version of the add-on can be:
By default, the stable version is updated with a stable version more recent (higher version number). But it is possible to update the stable version running with a development version of the next stable version. Just check the option "Update also update the stable release to the versions of development" located in the "Update" category of add-on's settings.
A development version is updated:
The button "Search for update" placed in the add-on's settings, menu item "Update", allows you to search immediately for an update.
The "View history" button, placed in this same category, allows you to display the history of the current version in the browser.
In the case of an automatic update and if a new version is detected, the "Update" dialog box is displayed to suggest:
In the case of an update to a stable version, the "What's new" button offers the possibility of opening, in the browser, the history of the add-on and thus being able to know the new features of the proposed version.
In this mode, the operation of the add-on is degraded.
Like NVDA, it is not possible to save configuration changes.
Some features are no longer available, such as:
The configuration of the "Voice profile switching" functionality having changed, it is deleted during an update from a version of the add-on older than 9.0. All selectors are released and the associated voice profiles are deleted.
The version history of this add-on is in the "changes.html" file
This add-on allows you to install or not install a particular feature. The installation status of each feature of the add-on is presented in the "features's installation" category of the "Settings" dialog.
This state can be:
By default, this add-on does not install all features.
In general, each script can be activated in two ways:
In NVDA's "Input gestures" dialog, the scripts provided by the add-on are placed in their own category.
The vast majority of scripts fall into the categories: "NVDA global commands extension", "Voice Profile Switching", "Configuration", "Tools" and Speech.
For scripts that can be started by an interpreter command, thiscommand is indicated after the description of the script.
Depending on the choice of installing a feature ("Install" or "Install without input gesture"), the input gestures provided by default are assigned or not to the scripts of this feature.
By default, the vast majority of scripts that can be started by the command interpreter are not assigned to any input gestures.
This is started using the "NVDA+j" input gesture. A beep is then audible.
It is then possible to activate the scripts of the functionalities using commands.Today, these commands cannot be changed.
The "h" command of the interpreter lists all the scripts of the installed functionalities accessible by a command of the interpreter. In this list, it is possible to launch the selected script by pressing the "Enter" key.
The "g" command of the interpreter opens the add-on's user guide.
The command interpreter stops either:
This feature is, by default, installed with input gestures.
It adds the following scripts:
These scripts are placed in the "NVDA global commands extension" category of the NVDA "Input gestures" dialog.
This script initially created by Yannick Maillot and Daniel Poiraud was installed using the independent add-on "ListIconesZoneNotification_v1.2.nvda-addon" which must therefore be uninstalled.
Its description is: "Shows the list of buttons on the System Tray "
It is started by the command "F11" of the command interpreter. It is the counterpart of the Jaws script "Insert + f11".
No input gesture is assigned to it by default.
It displays a dialog box which contains:
Navigation in the dialog box is by "Tab" or upper case + Tab "and in the list with the up and down arrows.
Pressing the "Esc" key closes the dialog box.
In the list of icons, pressing the "Enter" key triggers the pressing of the "Single left click" button.
The description of this script is: "Display the running application windows's list with opportunity to put one of them on the foreground or destroy it ".
It is the counterpart of the Jaws script "Insert + f10".
It is started by the command "F10" of the command interpreter.
No input gesture is assigned to it by default.
It displays a dialog box which contains:
Navigation in the dialog box is by "Tab" or upper case + Tab "and in the list with the up and down arrows.
In the list, it is possible to select by typing the beginning of the title of the desired window.
Pressing the "Esc" key closes the dialog box.
In the list, windows are marked as maximized or minimized.
Pressing the "Switch to" button or the "Enter" key when you are in the list of windows, closes the dialog box and brings the window of the selected application to the foreground, giving it the focus.
Pressing the "Destroy" button closes the window of the selected application and returns the focus to the updated list of application windows.
Pressing the "Destroy all" button closes all the windows and the dialog box.
The description of this script is: "Shows the list of buttons on the System Tray. Twice, Display the running application windows's list with opportunity to put one of ".
By default, the "NVDA+F11" input gesture is assigned to it.
No interpreter command is assigned to it.
A simple press of the "NVDA+F11" input gesture launches the "Display of the list of icons in the notification zone" script (see above).
Pressing twice launches the script "Displaying the list of windows of the applications launched" (see above).
This feature is by default, installed without input gesture.
It adds the following two scripts:
These scripts are stored in the "NVDA global commands extension" section of the NVDA "Input gestures" dialog.
This script is launched:
It displays the "Help for the composition of complex symbols" dialog box made up of:
We move in the dialog box by "Tab" or "Shift + Tab".
Pressing the "Esc" key closes the dialog box.
When you are in the list of categories, pressing the "Enter" or "Tab" key brings the focus to the list of symbols of the selected category.
These symbols are listed in the order of the "symbolCategories.dic" file (see below).
On the other hand, if you are in the list of symbols and a symbol is selected, pressing the "Enter" key causes the "Paste" button to be pressed.
Positioned on a symbol, pressing the "Space" key causes the symbol code to be vocalized in the form: decimal code followed by the spelled hexadecimal code. This can be useful if you want to manually compose the symbol by the Windows command "Alt + 0" followed by the decimal code dialed on the numeric keypad.
Pressing one of the three buttons closes the dialog box.
The "Manage your symbols" button presents the dialog box which offers the possibility of completing the basic categories of the add-on with your own symbols. This dialog box displays:
Empty or comment lines (starting with "#") are accepted.
These files are kept during an add-on update, even if the user asks not to keep their own settings. The installation of the add-on adds, for each language, the pronunciation of certain symbols found in the basic categories and which NVDA does not have. The" symbols-xx.dic "file in the userConfig folder is either created, be modified to add the new pronunciations.
This add-on stores the last 20 symbols dialed for the current configuration profile.
This script allows them to be displayed and to recompose a commonly used symbol. This avoids going to search for it in its category with the previous script.
This script is started by the command control+f4 "of the command interpreter. No input gesture is assigned to it by default.
It presents the same kind of dialog box as the previous script without the button to manage its own symbols.
The maximum number of last symbols can be configured with the option "Maximum number of last recorded compound symbols" placed in the "Advanced" category of the "Settings" dialog of the add-on.
This feature is installed by default without input gesture.
It installs, according to its state of installation, the following scripts:
And in any case, the scripts:
These scripts are stored in the "Tools" section of the NVDA "input gestures" dialog.
The description of this script is: "Speaks the filename of the active application along with the name of the currently loaded appModule python file. Pressing this key twice,speak the name and state of the current configuration profile".
By default, the "NVDA+control+F1" input gesture is assigned to it.A single press of the input gesture triggers the basic NVDA script which announces the name of the application file and if there is one, the name of the loaded python appModule's name.
Pressing twice announces the name of the configuration profile and its status.
The description of this script is: "Announce the name and version number of the application under focus".
By default, the "NVDA+shift+f1" input gesture is assigned to it.
The input gesture triggers the announcement of the name and version number of the application placed under focus.
The description of this script is: "Display informations about the focused application".
It is started with the "a" command of the interpreter.
By default, No input gesture is assigned to it.
It displays the "NVDA global commands extension - Information" dialog box which presents the following information:
The description of this script is: "Announce the name and version number of the add-on activated for the application under focus".
By default, no input gesture is assigned to it, nor any interpreter command.
This feature is installed by default.
It concerns Mozilla Firefox, Microsoft Internet Explorer, Google Chrome, Microsoft Edge (partially) browsers and provides:
This add-on adds the following commands for the browse mode:
Except for the first four, these commands are not implemented in the Microsoft Edge browser.
Basically, the script integrated into NVDA and triggered by the "NVDA + f7" input gesture, allows you to display the "List of elements" dialog box presenting the list of certain elements found in a Web page. This add-on increases the number of item types that can be chosen and displayed in the title of the dialog,the selected type.
The list of these types becomes:
Basic types:
Types added by the add-on:
These types are presented as a list instead of a radio button (in the basic version).
A type can be reached by typing the first letter of its label.
At each change of type, the number of elements found is announced or if no element is found, the voice indication "no element" is broadcast.
A repeating beep sound is heard while searching for items.
The status "checked" or not checked "is signaled for the checked boxes.
The "edit" type gives the list of the document's edit zones, and each element is presented vocally as follows:
Likewise, each form field is presented vocally according to its type.
For Microsoft Internet Explorer, Microsoft Edge, Mozilla Firefox, GoogleChrome browsers, it is possible when the cursor is on a table cell of:
The last four scripts are removed from the extension for versions greater than or equal to 2022.2 because they are now provided by NVDA.
All of these scripts are stored in the "Table" category in the tree view of the NVDA "input gestures" dialog.
This add-on also moves NVDA base scripts that used to be under the "Miscellaneous" category into this category. Those are:
The input gesture "NVDA+a", (desktop computer) or "NVDA+shift+a" (laptop) typed in Mozilla FireFox, Microsoft Internet Explorer, Microsoft Edge or Gooble Chrome browsers, announces the address (URL) of the document. With a double press, this address is copied to the clipboard.
In browse mode, the search for the next or previous item stops at the end or the beginning of the document.
This add-on adds, as an option, the possibility of cyclically browsing the document, that is to say:
The passage through the beginning or the end of the document is signaled by a sound and a voice message.
The "Loop navigation" option in the "NVDA Add-ons" category of the add-on's "Settings" dialog allows you to enable or disable this operation.
This option is only shown if the "Extend virtual buffer functionality" feature is installed.
By default, this option is not checked. The basic operation of NVDA is retained.
This feature is installed by default.
The functions triggered by the shortcuts "control + v", "control + c", "control + x", "control + z" are not vocalized by NVDA, this extension takes care of them.
No check on the result of the function is done.
But:
It is strongly advised not to install extensions that provide the same kind of functionality.
If this feature is installed, the following scripts are installed.
This feature adds the script that allows you to add the selected text to the clipboard.
This script is installed without input gesture, but it is possible to assign one to it using the NVDA "Input gestures" dialog. Its description is "Add, to clipboard, selected text" and is placed in the "NVDA global commands extension" category.
All the parameters used for the script are located in the "Clipboard" group of the "Keyboard" category of the add-on dialog which presents the settings of the current configuration Profile.
It is started using the "x" interpreter command.
Following the command, the selected text is added to the content of the clipboard, either after or before depending on the state of the "Add to clipboard before"checkbox.
It is possible to place a separator text between the text blocks. This text can be configured using the Edit Text field used as a separator between the contents added to the clipboard ".
A confirmation request will be displayed before proceeding with the addition if the "Ask confirmation before adding to the clipboard" checkbox is checked.
Note: this script is taken from the "ClipContentsDesigner" add-on (Authors Noelia, Abdel) which also provides other interesting features regarding the clipboard. It was put in this add-on on request of users who wanted at the same time the announcement of the functions "copy" and "paste".
This script replaces the base NVDA script ("NVDA+c") to complete it by telling the user who ran the command that:
the number of characters read is no longer limited to 1024.
This maximum number can be configured using the "Maximum reported characters" choice in the "Clipboard" group of the "NVDA enhancements" category.
This script is installed without a input gesture, but it is possible to assign one using NVDA's "Input gestures" dialog.
Its description is "Empty the clipboard" and is placed under the "System status" category.
Its function is to completely erase the contents of the Windows clipboard. Attention, this does not concern the history of the Windows clipboard.
It is launched using the "contrôle+x" interpreter command.
This feature is installed by default without input gesture.
It adds, for the dialog boxes of the style "Open", "Save", "Save as", "Find in",scripts which allow to know the name and the path of the folder which is selected to define the location where the file will be searched where to save.
These scripts are placed in the "NVDA global commands extension" category of the NVDA "input gestures" dialog. Those are:
No input gesture is associated with the last two scripts, but it is possible to associate one to them using NVDA's "input gesture" dialog.
Please note, these scripts only work in dialog boxes conforming to the Windows standard.
This feature is by default, installed without input gesture.
It adds the scripts:
These Scripts are stored in the "Tools" category of the NVDA "input gestures" dialog.
The description of this script is: "Open a dialog to manage NVDA logs".
It is started using the "j" command of the interpreter. No input gesture is assigned to it by default.
This script displays the "NVDA Log Management" dialog box showing:
The log opens in the program associated with the .log add-on. If there is not yet the association of a program with this add-on, you will have to define it (choose the notepad for example).
The description of this script is: "Open current NVDA log file. Pressing this key twice, open the old NVDA log file. Pressing third, copy current log path to the clipboard".
It is launched using the "NVDA+shift+j" input gesture which is assigned to it by default.
A simple press triggers the opening of the current NVDA log.
A double press opening the old log.
A triple press, copying the path of the current log to the clipboard.
The log opens in the program associated with the .log add-on. If there is not yet the association of a program with this add-on, you will have to define it (choose the notepad for example).
This feature is installed by default without input gesture. In order to be able to listen to voice announcements that are poorly understood or heard badly, this add-on records a limited history of speech strings sent to the synthesizer. The number of records is limited to 200.
To listen to these recordings again, the following scripts, placed in the "Speech" category of the NVDA "input gestures" dialog, are provided by this functionality:
This script is started using the input gesture, "NVDA+control+f8" assigned by default.
The input gesture triggers the announcement of the previous recording compared to the last announced recording.
This script is launched using the input gesture, "NVDA+control+f10" assigned by default.
The input gesture triggers the announcement of the next recording compared to the last announced recording.
The description of this script is: "Report current record of the speech history and copy it to clipboard. Twice: display speech history".
This script is started using "NVDA+control+f9" input gesture assigned by default.
A simple press triggers the announcement of the last recording.
A double press, triggers the copy of the recording to the clipboard.
A triple press, displays the entire history.
The description of this script is: "display speech history records".
This script is started using the "f9" command of the interpreter. No control gesture is assigned to it by default.
It presents the "Speech history" dialog box which lists these recordings in descending order of their age. A button is used to copy the selected recording to the clipboard.
By default:
This feature is installed by default.
It allows you to rename certain keyboard keys as "Caps lock" or "Numeric lock" using a dialog box which presents:
When a replacement label is defined for the selected key, the read-only edit box, reachable by "Tab", displays this replacement label. This label is announced when the key is focused.
The "Delete" button allows you to delete this replacement label.
It is also possible to delete this label by entering an empty or full string in the input box.
The "Delete all" button allows you to delete all the replacement labels to return to the basic labels provided by NVDA.
The "OK" button is used to apply the overrides and to save the keyboard keys and their replacement label in the add-on configuration file in the "RedefinedKeyLabels" section and the corresponding NVDA language subsection (" fr "for example for French). It is thus possible to have key renames for different languages.
To display this dialog, three possibilities:
It is possible to not install this feature by selecting, in the "Installed features" category and for the "Keyboard keys renaming" feature, the "Do not install" status.
This feature is installed by default.
NVDA allows the command keys to be spoken by voice using the "Speek command keys" option located in the "Keyboard" category of the NVDA "Settings" dialog or by the "NVDA + 4" input gesture.
This functionality provides, by configuration and using a dialog box, the possibility of:
To display this dialog, three possibilities:
The dialogue presents:
Pressing the space bar checks or unchecks the selected key or combination.
If the "Speek command keys" box in the dialog box is not checked, checking a key will cause that key to announce anyway when NVDA is configured not to announce them.
The list of modifier key combinations is then accessible and all the elements in this list are checked by default.
To prevent the key typed with a particular combination from being announced, it suffices to uncheck this combination.
If the "none" item in the combination list is checked, the key will be announced even when pressed without a modifier key combination.
On the other hand, if the "Speek command keys" check box is checked, checking a key prevents this key from being announced when NVDA is configured to announce them.
The list of modifier key combinations is then accessible and all the elements of this list are checked by default. This means that the key typed with or without a combination will not be announced.
The action of unchecking a combination then makes it possible to announce the key with this combination.
The "none" element in the list of combinations makes it possible not to have the same key announced without a combination of modifier keys.
The "Uncheck all" and "Check all" buttons allow you to uncheck or check all the elements in the list of modifier key combinations.
The first item "any key with modifier key combination" in the list of keys allows, without designating a particular key, to select a set of modifier key combinations. Any key typed with one of these combinations will be announced or not, depending on the configuration mode chosen.
The "OK" button saves the choices made for the current configuration profile, while the "Cancel" button forgets them.
In the lists, the "F2" key and the "shift + F2" key combination allow you to move respectively to the next or previous checked item.
It is possible to not install this functionality by selecting, in the "Installed functionalities" category and for the "Selective announcement of command keys" functionality, the "Do not install" status.
This feature is installed by default.
It allows you to start a timer for a programmable duration.
When the timer expires, a dialog box appears displaying a programmable announcement and the emission of a ringtone.
It installs a script which starts:
If the timer is stopped, the script displays the "Launch timer" dialog box which presents:
The duration, the announcement and the time to be warned before the timer expires are recorded each time the timer is started and displayed by default the next time the timer is started.
If the timer is in progress, the script then displays the "Timer in progress" dialog box allowing you to know the remaining duration of the timer and possibly to stop the timer.
The duration is refreshed every 5 seconds and is announced when the focus is in the edit zone (read-only) displaying it.
This dialog box closes automatically when the timer expires.
This feature is not installed by default.
It installs a script that allows restarting NVDA in debug logging level without modifying NVDA configuration.
The description of this script is: "Restart NVDA. Twice: restart with log levelset to debug".
It is placed in the "Miscellaneous" category of the NVDA "input gestures" dialog.
The "NVDA+control+f4" input gesture is assigned to it by default.
A simple press of this gesture triggers a restart of NVDA with the logging level configured in the general preferences.
Double pressing of this input gesture restarts NVDA with the debug logging level without changing the logging level configured in NVDA general preferences.
By default, this feature is installed with input gesture.
It installs two scripts stored in the "System focus" category of the NVDA "input gestures" dialog:
The description of this script is: "Display the list's visible items making up current foreground object".
It is started using the "b" command of the interpreter.
No input gesture is attributed to it.
The script starts searching for these items. This can take a long time. An audible signal every two seconds is emitted during this search.
To limit this search time, limits are put in place for certain types of elements:
When the search is complete, the elements are displayed in the "List of visible elements making up the foreground object" dialog box, according to their type.
This dialog box presents:
In the list of elements, it is possible to change the type of objects to list without leaving the list:
Also in this list, it is possible to reach an element by typing the first letters of its label.
For an element of type:
The description of this script is: "Reads all controls in the active window. If pressed twice: display the list's visible items making up it".
It is launched using the "NVDA+b" input gesture which is assigned to it by default.
A single press launches the basic NVDA script which announces all objects of the object in the foreground.
Pressing twice launches the previous script "Display of visible elements of the object in the foreground".
This feature is installed by default without input gesture.
It allows you to quickly change voice profile by giving the possibility of memorizing up to 8 voice profiles and quickly selecting one of these voice profiles.
A voice profile is defined by:
It installs the following scripts under the "Voice Profile Switching" category of the NVDA "input gestures" dialog:
The description of this script is: "Display dialog to manage voice profile selectors".
It can be activated by:
This script displays the " Voice profile selectors's management of the ProfileName configuration profile" dialog box (where ProfileName is the name of the triggered configuration profile).
This dialog box is used to manage the selector-voice profile association and presents:
The "Selectors" list shows the list of free selectors or those associated with a voice profile. The associated selectors are:
When the selector is indicated as "free", the "Associate voice profile" button allows you to associate the current voice profile with this selector. This button brings up a dialog box allowing you to give a name to this voice profile. A default name is proposed. The "Default" button allows you to return to this proposal.
When a selector is already associated with a voice profile, it is then possible:
If the selected selector is an associated selector under the normal configuration profile, then it is not possible to release it, but it can be associated with the current profile.
Only the selectors associated under the current configuration profile can be released.
To quickly change voice profile, the "Voice profile switching" mode is set up.
To activate or deactivate this mode, the "p" command of the interpreter must be typed.
This mode activated,the right or left arrows are used to move to the first next or previous selector associated with a voice profile and thus define the voice profile associated with this selector as the current voice profile.
The selectors taken into account are the selectors from the "Selectors" list which are associated with a voice profile.
To quickly change voice profile, the "Voice profile switching" mode is set up and a script is used to activate or deactivate it.
The description of this script is: "Activate or deactivate Voice profile switching mode".
To run this script, two possibilities:
When this mode is activated, the right or left arrows are used to move to the first next or previous selector associated with a voice profile and thus define the voice profile associated with this selector as the current voice profile.
The selectors taken into account are the selectors from the "Selectors" list which are associated with a voice profile.
The description of this script is: "Go backward to the first selector associated to a voice profile and set this voice profile as current voice profile".
It is launched using the "nvda+shift+control+left arrow" input gesture which is assigned to it by default.
The script searches for, in the "Selectors" list, the first selector preceding the current selector associated with a voice profile. Then he positions this voice profile as the current voice profile.
The description of this script is: "Go to forward to the first selector associated to a voice profile and set this voice profile as current voice profile".
It is launched using the "nvda+shift+control+right arrow" input gesture which is assigned to it by default.
The script searches for, in the "Selectors" list, the first voice profile selector following the current selector associated with a voice profile. Then he positions this voice profile as the current voice profile.
8 scripts are installed. The description of these scripts is: "Set selector x as current selector and Sets , if possible, it associated voice profile as current voice profile" (where x is the number of the selector).
Each script is launched using the "nvda+shift+control+selector number" input gesture assigned by default.
The script selects the selector x and if it is associated with a voice profile, positions this voice profile as the current voice profile.
The following 3 scripts allow you to know the current speech settings without having to use the "Speech" NVDA menu.
They are stored in the "Speech" category of the "Input Gestures" NVDA dialog and are installed even if the "Voice Profile Switching" feature is not installed.
No input gesture is associated with them, but it is possible to assign one to each.
Their descriptions are:
This feature is not installed by default.
It allows to make the NVDA keys ("Insert" of the normal or extended numeric keypad, "Caps Lock" key) and the modifier keys ("shift", "control", "left Alt", "Control right Alt" , "Windows") to be made peersistent.
The objective being to be able to use only one finger, for example, to compose a input gesture requiring the pressing of several keys.
It places a "Keys's remanence" grouping in the "Keyboard" category of the addd-on's "Settings" dialog.
To activate or deactivate keys's remanence, all you have to do is dial one of the following keyboard key sequences:
They are checked by default.
During this time delay, any further press on one of these keys restarts the time delay and this new key is also memorized, but no beep is emitted.
Pressing any other key on the keyboard executes the input gesture made up of the combination of all the keys memorized with this last key.
Each time this last key is pressed again during the timeout, the input gesture will be executed again.
If this key is typed out of time, it is executed alone and the memorized keys are forgotten.
Warning: You have to wait for the end of afterglow to have any new key treated individually. For example: "Alt" to display a menu then expand the menu items.
It is however possible to stop the remanence before the end of the time delay, by re-entering the last key in remanence.
This remanence is specifically set up for the gmail.com site and is only active in the "https://mail.google.com/mail/#i" page.
It is not active by default. A checkbox "Special remanence for Gmail.com" is provided in the "Keystroke persistence" grouping.
In this page, it is possible to type shortcuts to launch commands but some of them chain two letters. In particular, the letters "g", "h", "*" must be followed by another letter. This sequence must be fast enough to trigger the execution of the associated command. This is problematic for people who do not have sufficient dexterity.
The objective of this remanence is therefore to retain the first letter while waiting for the second to be struck.
When the first letter is struck, a time delay is started (a dull beep is heard) and the letter is stored.
Typing the second letter within the configured remanence delay will send both letters to the browser and the timeout is stopped.If no new letter is entered, the first letter is sent to the browser at the end of the time-out (a high-pitched beep is audible).
In order for NVDA to send the letters to the browser, it is necessary to switch to form mode first.
This feature cannot be uninstalled.
It installs a script whose description is: "Display the dialog to shutdown, restart or hibernate".
It is started using the "r" command of the interpreter. This script displays a dialog consisting of the following elements:
This feature also installs the scripts corresponding to the functions of the three buttons, but with the following behavior:
If a non-zero waiting time is configured, a dialog box then presents the waiting time remaining before putting the computer to hsleep, shutting down or restarting.
The "Cancel" button or the "Escape" key is used to interrupt the request.
Reporting of remaining wait time respects NVDA's "tracking progress bars" option.
The "Announce the remaining waiting time" button allows you to read the waiting time displayed in the dialog box.
All scripts are placed in the "NVDA global commands extension" category of the NVDA "Input gestures" dialog, but no gestures are assigned to them.
This feature cannot be uninstalled.
Basically, NVDA allows you to add or remove input gestures using the "Input gestures" dialog. But there is no way to know which gestures are added or removed by the user.
This is what this functionality wants to meet.
To do this, it adds the script whose description is "Displays the dialog to manage the input gestures configured by user" and placed in the "NVDA global commands extension" category of the "input gestures" dialog of NVDA.
It is started using the "u" command of the interpreter. No control gesture is assigned to it by default.
This script displays an NVDA "input gestures" style dialog by selecting only the input gestures deleted or modified by the user.
The dialogue presents:
input gestures removed from a category are shown with the description: "input gestures removed".
As it is not possible to know the category and description of a deleted input gesture or of an added input gesture associated with a script of an add-on that is not activated or not installed at the time of the display of the dialogue, this gesture is presented like this:
As for the classic "input gestures" dialog, it is only by pressing the "OK" button that all gesture deletions will be taken into account.
Cancellation of all changes using the "Delete all" button is subject to confirmation. Upon acceptance, all changes are canceled and the dialogue closes.
By default, this feature is installed without input gesture.
It can only work under Windows 10 operating system.
If it is installed with or without a input gesture, it places the "Volume control" grouping in the "Computer" category of the "Settings" add-on dialog.
It installs the following scripts stored under the "Volume control" category in the "input gestures" NVDA dialog:
This script is launched:
It sets the main and NVDA volume and forces the levels of each to the values of the recovery levels configured in the "Volume control" grouping of the "Computer" category of add-on settings.
This script is launched:
This command mutes the volume of the audio stream of the focused application if it is established or restores it if it is muted.
These scripts are used to increase, decrease or fix the volume of the audio stream of the focused application.
They are installed without input gestures. But it is still possible to assign them with the "input gestures" dialog.
They are started using the following interpreter commands:
These commands, unlike the other interpreter commands, can be repeated without having to restart the interpreter. The interpreter is always active. Once the volume level is reached, press the "Escape" key to exit the interpreter.
The increase or decrease in volume is done in steps.It is possible to adjust the size of these steps in the parameters of the add-on under the "Computer" category, "Volume control" grouping, by choosing the size of the step.
Size 1 is the smallest step, size 20 is the largest step. The size is set to 5 by default.
By default, the app volume level cannot exceed the master volume level. But this limitation can be overridden if the option "Increase speakers volume if necessary" is checked. This option can be found in the "Volume modification" group of the "Computer" category of the global settings of the extension.
These scripts allow you to increase, decrease, or fix the volume of NVDA.
They are installed without input gestures. But it is still possible to assign them with the "Input gestures" dialog.
They are launched using the following interpreter commands:
These commands, unlike other interpreter commands, can be repeated without having to restart the interpreter. The interpreter is always active.
Once the volume level is reached, press the "Escape" key to exit the interpreter.
The increase or decrease in volume is done in steps. It is possible to adjust the size of these steps in the parameters of the extension under the category "Computer", group "Sound control", by choosing the size of the step. Size 1 corresponds to the smallest step, size 20 to the largest step. By default, the size is set to 5, which corresponds to 5 steps of varying the volume in the Windows mixer.
NVDA volume cannot fall below the configured recovery threshold.
By default, it cannot be greater than the primary volume, but this limitation can be overridden if the option "Increase speakers volume if necessary" is checked. This option can be found in the "Volume modification" group of the "Computer" category of the global settings of the extension.
These scripts allow to increase, decrease, or fix the main volume.
They are installed without input gestures. But it is still possible to assign them with the "input gestures" dialog.
They are started using the following interpreter commands:
These commands, unlike the other interpreter commands, can be repeated without having to restart the interpreter. The interpreter is always active.
Once the volume level is reached, press the "Escape" key to exit the interpreter.
The increase or decrease in volume is done in steps. It is possible to adjust the size of these steps in the settings of the add-on under the "Computer" category, grouping "Sound control", by choosing the size of the step. Size 1 is the smallest step, size 20 is the largest step. By default, the size is set to 5, which corresponds to 5 steps of varying the volume in the Windows mixer.
The primary volume cannot fall below the configured recovery threshold.
When using the preceding commands, the volume level is recorded before the execution of each command, for the main volume and for each application.
To return to this level, the following commands are available:
The previous level is also saved when these commands are executed.
These records are not kept when restarting NVDA.
Volume level changes are announced by default.But it is possible to deactivate this announcement using the "Report volume changes" option in the "Volume change" grouping of the "Computer" category.
For the volume of applications, this can be said:
The choice is made using the "Announce application volume level in percent" option in the "Volume change" grouping in the "Computer" category.
This function is used to restore, when loading this extension, the main volume and that of NVDA and to set the level of each volume to a value defined by configuration if it is lower than the minimum threshold defined by configuration.
For this, the "Sound control" group of the "Computer" category of the "Parameters" dialog of the extension, presents the following configuration elements:
When launched, this extension verifies that the primary volume and the NVDA volume are above the recovery threshold configured for each.
If this is not the case, this extension then fixes the volume level to the value of the level to restore configured.
When installing this extension, the current levels of the main volume and NVDA are taken into account when setting the values for the levels to be restored.
The description of this script is: "Copy date and time to clipboard". This script is stored in the "System Status" category of the NVDA "input gestures" dialog.
It is started using the "d" command of the interpreter. No input gesture is attributed to it.
As its description indicates, it allows you to copy the date and time to the clipboard.
The extension installs a script whose description is: "Reports the current time. Twice, reports the current date. Third: copy date and time to the clipboard".
This script is stored in the "System status" category of the "input gestures" NVDA dialog.
No interpreter command is associated with it.
If the extension's install status is "Install", this script replaces the NVDA script and is started using the "NVDA + f12" input gesture.
Otherwise no input gesture is assigned to it, but it is still possible to assign it using the NVDA "input gestures" dialog.
This script allows:
It also brings:
The basic input gesture "NVDA + f12" gives the time with a simple press, but the time is not announced in the same way depending on the Level of punctuation and symbols selected in the voice parameters.
This script corrects this small flaw by announcing the time with the Level of punctuation and symbols forced to "None" without modifying the level defined in the "Speech" category's parameters.
By default, NVDA's input gesture "nvda + f12" announces the time without the seconds.
This script offers the possibility of announcing the time in seconds.
All you have to do is check the "Report windows clock's time with seconds" checkbox in the "Computer" category of the add-on's Settings dialog. This option is not checked by default.
This option is not present if the installation status of the feature is "Do not install".
To compensate for the absence of the "Applications" key on some computers and not knowing whether the "upper case + f10" shortcut fulfills the same function, the add-on installs a script without a input gesture in the "Emulated keys of the keyboard" category system "with the description"Emulate key press: applications".
To use it, all you need to do is assign it a input gesture or a keyboard key that is rarely used, such as the "print screen" key, the "Pause" key.
The add-on installs a script to close all open windows.
This script is placed in the add-on scripts category and under the description "Close all opened windows".
It is started with the command "k" from the command interpreter. No control gesture is assigned to it by default.
The add-on manager displays the list of installed add-on and their status: activated or deactivated.
But even though it is enabled, an add-on may not be loaded by NVDA. Usually the NVDA log reports this, but nothing in the Extensions Manager.
It can be interesting at some point to know which add-on are actually running.
To do this, the add-on installs a script under the description "Display running add-ons list" in the category of add-on in the "input gestures" dialog.
This script is started with the "e" command of the command interpreter. No control gesture is assigned to it.
add-on are listed by type:
This feature is not installed by default.
It installs the script whose description is "Display tools for add-on development dialog".
This script is stored in the "Tools" category of the NVDA "input gestures" dialog.
This script is started using the "t" command of the interpreter. No control gesture is assigned to it.
Activating this script brings up a dialog presenting:
To package an add-on (create the add-on installation file), we recommend that you use the "nvda adon scons template". This model uses a "buildVars.py" file which defines, for an add-on, all the necessary information such as: its internal name, its version, its name and its description to be translated into each language supported by it. This model is also used to allow the translation of add-on strings with the translation system set up by the "NVDA-addon.org" community.
The objective of this model is, when an add-on has been developed, by a simple command and after having informed the "buildVars.py" file of:
When we create an add-on, there is nothing. You must create the "manifest.ini" file yourself, possibly the localization "manifest.ini" file and the documentation file.The objective of these tools is placed in this condition and is:
The first step is to create the "buildVars.py" file from the information in the "manifest.ini" file that we created for the development of the add-on.
The "Create the buildVars.py file" button starts this operation.
It is only this file that we will then modify to update the "manifest.ini" file (change of version or description for example).
To be used with the "adon scons template", it will have to be completed by filling in the information which is not found in the "manifest.ini" file.
The "Update add-on version" button allows you to modify the version defined in the buildVars.py file of the selected add-on.
It presents a dialog box containing an edit zone initialized with the current version of the file.
Pressing the "OK" button saves the new version in the file.
The "manifest.ini" file must be updated as soon as the "buildVars.py" file is modified.
Use the "Update manifest.ini file" button for this.
Any modification of the "addon_summary" or "addon_description" information of the "buildVars.py" file requires the translation of this description into each language supported by the extension (taken into account in the nvda.po file and compilation of this file) .
In order for the add-ons' Manager to present this information to the user for the language chosen for NVDA, you must create or update the localization "manifest.ini" file for that language.
The button "Create the localization manifest.ini file" allows this. It is possible to update the file for the selected language or for all languages.
Add-oon documentation files can be either in "markdown" (. Md) or "txt2tags" (.t2t) format.
To be presented to the user in a browser, these files must be converted to HTML.
This is possible simply using the "Create HTML documentation files" button after selecting the add-on in the list of add-ons and choosing a language or all the languages in the list of languages.
Opened in the browser, these HTML files need style files (style.css for Markdown files and style_t2t.css for txt2tags files) placed in the add-on's "doc" folder.
The "Create POT file" button is used to create the catalog file for the selected add-on.
Once created, this file is placed in the add-on's "locale\en" folder and is named "version-name.pot" where "name" is the name of the extension and "version" is its version.
The "Prepare add-on" button launches, for the selected add-on, the execution of the following actions:
The "Explore add-on folder" button opens Windows Explorer in the selected add-on folder.
The purpose of this feature is to allow the user to restart NVDA with the user configuration of his choice.
For this, it relies on the possibility that NVDA offers the user to indicate the path of the configuration directory in the command line that starts NVDA.
All the configuration parameters are saved in a specific folder on the hard drive and by default this folder is located:
But this configuration folder can have another name and be located elsewhere on the hard drive or USB drive.
To ask NVDA to use it, just indicate it by launching NVDA with the command line: nvda.exe -c "directoryPath"
If the directory does not exist, NVDA creates it when it starts up and initializes it as when it was first started after installation.
Otherwise, NVDA starts using the settings in this configuration folder.
It is therefore possible to have several user configurations with the same NVDA.
This allows for example to have, in addition to the basic configuration, either a test configuration to try new extensions, or a configuration with a very precise setting for a particular situation.
This functionality therefore provides the means to:
First of all, you must define the configurations that will be used.
For this, the extension installs the script "Display the dialog to manage user configurations" which is launched using the interpreter command "n".
No input gestures is assigned to it, but it is still possible to do so using the NVDA "Input gestures" dialog.
This command is used to display the "User configuration management" dialog which presents:
The list contains all the folders added by the user and this added automatically by the extension.
The active configuration folder is signaled by voice and by the "checked" symbol in front of its name.
When this dialog is displayed for the first time, the extension automatically places it in the list and saves it.
For this folder, the "Delete this folder" and "Empty this folder" buttons are not present.
A newly added folder that is not yet a configuration folder is marked with a question mark.
An NVDA configuration folder is characterized by its content. It must contain, in particular, the following elements:
The "modify this folder" button is not present if the selected folder is the active configuration folder.
The "Add a new folder" and "Add an existing folder" buttons allow you to add a folder to the list of configuration folders.
Pressing the first button displays the "Add a new folder" dialog which shows:
The folder identifier is used to name the folder like this: "nvdaUserConfig-identifier".
It is under this name that the folder appears in the list and on the hard or USB drive.
Pressing the second button brings up the "Add an existing folder" dialog which presents:
The "Delete this folder" button allows you to remove the selected folder from the list and erase it from the drive.
This button is not available if the folder is the folder of the active configuration.
Confirmation of deletion for this action will be requested.
Depending on whether the folder is a configuration folder or not, the dialog shows respectively:
They aim to provide the tools to import settings from another configuration folder.
Activating these buttons each displays its own dialog which is differentiated only by their title.
In these dialogues we find:
The name of the folder that will be modified is indicated in the title of the dialogs.
The action of each button concerns the content of the folder selected in the list.
For the import of add-ons, it is possible to import all or part of the add-ons of the selected folder and to keep or not the add-ons already included in the folder to modify. The same goes for importing profiles.
Importing the entire configuration allows you to completely duplicate the selected folder and thus have an identical copy of the configuration of this folder.
The "Restart NVDA with this folder" button allows you to restart NVDA with the configuration of the selected folder.
This folder can be:
In order for this other configuration to benefit from the same possibility of restarting, this add-on must also be installed there.
In this case, it will not be necessary to redo the addition of the configuration folder. The add-on will resume previously saved folders.
This registration is done in the "NVDAExtensionGlobalPlugin-userConfigs.ini" file stored in:
The "Explore this folder" button opens the configuration folder selected in the explorer.
NVDA reboots and initializes the configuration as during a post install boot.
After the first 5 steps:
By combining the previous example and this one and using a USB drive as a medium, you can find the same configuration on different machines.
This functionality is currently being tested.
When editing or proofreading a document using only speech, inconsistencies such as unmatched parentheses, unintended formatting changes, extra spaces, and spurious or unspaced punctuation marks can often be missed.
The "Text analysis" feature installs a tool (analyzer) which warns you of these irregularities, using a voice message or a WAV file when replaying by word or by line.
You can configure the analyzer to announce these irregularities by number, description, or sound.
The analysis is broken down into three research groups:
It is possible to deactivate a search group as well as, individually, each action of a group.
To do this, the "Text analysis" category is added in the extension settings dialog.
The settings in this category are specific to the active profile that is announced when the category is selected.
The analyzer can be turned on or off in three ways:
Enabling and disabling the analyzer only affects the active configuration profile.
The checkbox "Activate the text analyzer when starting the extension" in the "Text analysis" category fixes, for each profile, the activation state of the text analyzer when the extension is launched. 'extension.
The analiser activated, it is analyzed each time the cursor is moved from word to word, or from line to line in the text edit zones.
The result of the analysis is indicated according to the choice made, by:
For the alert configuration, see the "Alert" group of the "Text analysis" category.
It is enabled by default.
Some symbols like parentheses, brackets, braces usually go in pairs: an opening symbol, a closing symbol.
This research consists of verifying this concordance.
The possible symbols are listed in the "symbols" list of the "Symbol concordand" group of the "Text analysis" category.
Each symbol may or may not be part of the search depending on whether it is checked or unchecked in the list.
The symbols in the list depend on the language chosen for NVDA. They are defined in the "textAnalyzer.ini" file placed in the folder associated with the language of the "locale" folder.
It is enabled by default.
The list of anomalies to be sought is presented in the "Anomalies" group of the "Text analysis" category.
These are :
In the list, these are checked boxes. By default, they are all checked. By unchecking a box, the verification concerning it will not be done.
For anomalies concerning spaces around a symbol, the symbols involved are indicated by checked in the list containing all the symbols provided. Depending on the need, it is possible to check or uncheck a particular symbol. The symbols checked by default are defined for each NVDA language requiring it in the "textAnalysis.ini" file placed in the language folder of the "locale" folder.
It is disabled by default. Formatting changes can be signaled by the analyzer depending on the status of the "Report changes" checkbox in the "Formatting" group of the "Text Analysis" category.
The formatting changes concern:
They can be included or excluded individually from the search by checking or unchecking them in the "Types" list of the same group.
The extension installs scripts to analyze text at the cursor position on demand. These scripts are:
The following scripts allow to move the cursor to the beginning of the next/previous line containing at least one irregularity:
They have no input gesture associated with them, but it is possible to do so using the "Input gestures" dialog. They are placed in the "NVDA global commands extension" category.
The script "Toggle reporting of current caret position in edit box" allows you to have the cursor position announced or not when it is in an edit zone.
This position is relative to the start of the line on which the cursor is located.
The activation or deactivation of this announcement is specific to the current profile.
The script is installed without a input gesture and with the "f7" interpreter command.
If desired, NVDA's "input gesture" dialog allows you to assign an input gesture to it.
This feature is installed by default.
It allows you to temporarily change the current audio output device to another audio output device without impacting NVDA's configuration for all configuration profiles.
Each configuration profile will retain the settings configured in the "Speech" category used by NVDA, including its audio output device.
We will name this device, "Temporary Audio Device".
When a temporary audio device is active, audio sound (voice messages and tones) emitted by NVDA will be sent to that device regardless of the audio output device in the active configuration profile.
Sounds emitted by the system continue to be sent to the audio output device selected in the Windows settings.
Since nothing is changed in NVDA's configuration, automatic or manual registration of NVDA does not keep any trace of this device.
To return to normal operation, ie the use of the audio output devices of the configuration profiles, it will suffice to abandon the temporary audio device.
To achieve all this, the extension installs several scripts.
This script has the description "Display the temporary audio device manager" and is placed in the "Speech" category of NVDA's "Input gestures" dialog.
No input gesture is assigned to it, but it is still possible to assign it one using this dialog.
It is started using the "c" command of the command interpreter.
In response to this command, the "Temporary audio device manager" dialog is displayed which presents:
In the list, movement is done using the "up" and "down" arrows.
When a peripheral is selected, a double beep is heard at its exit to make it possible to check its correct operation or connection and thus not to activate it.
Switching to the selected device is done either by pressing the "Set as temporary audio device" button (default button), or if the focus is in the list, with the "Enter" key.
This device becomes the temporary audio device.
Audio from NVDA is then routed to the output of that device.
In order not to end up with a device that emits no sound,the extension asks the user if they confirm the use of this device. This request is made after failover to this device and is timed out.
It can be prevented using the "Ask for confirmation" option in the "Temporary audio device" group of the "computer" category of the "Global settings" dialog of the extension.
This confirmation request consists of displaying a dialog box for a limited time and asking the user to accept the use of the new audio output device.
The display time of this dialog box can also be configured using the "Maximum waiting time for confirmation" drop-down list located in the same group as the previous option.
Pressing the "OK" button or the "Enter" key validates the acceptance.
At the end of the delay without pressing the "OK" button or the "Enter" key, the box closes and the sound returns to the previous audio output device.
To return to normal operation, ie without a temporary audio device, all you have to do is restart the script and activate the "Leave up temporary audio device" button or, more abruptly, restart NVDA.
In the list of audio output devices, it is possible to check certain devices. These devices will be used for the script "Define, as temporary audio device, the following device in the list of checked devices of the manager of the temporary audio device" (see below).
There are two ways to change the device:
This script has the description "Set, as temporary audio device, the next device in the list of checked devices of the temporary audio device manager " and is placed in the "Speech" category of the "input gestures" dialog.
No input gesture is assigned to it. But it is still possible to do this using the previous dialogue.
It is started using the "shift+c" command from the command interpreter.
Each time the script is started, a new audio output device is set as a temporary audio device.
This device is chosen from the devices that were previously checked in the list of audio output devices in the "Temporary audio device manager" dialog (see above). The one selected is the one following in the list, the current audio output device.
After changing the device,a timed confirmation request (optional) is requested (see chapter "Temporary audio device manager").
This script has the description "Leave up Temporary Audio Device" and is placed in the "Speech" category of the "Input gestures" dialog.
No input gesture is assigned to it. But it is still possible to do this using the previous dialogue.
It is started using the command "control+c" from the command interpreter.
The script has no effect if no temporary audio device is active.
Otherwise, NVDA's audio output is then routed to the audio output device of the active configuration profile.
This script has the description "Set, as temporary audio device, the next device in the list of checked devices of the temporary audio device manager" and is placed in the "Speech" category of the "Input gestures" dialog.
No input gesture is assigned to it. But it is still possible to do this using the previous dialogue.
No interpreter command is assigned to it either.
This script combines the two previous scripts under one script.
The first press of the input gesture launches the script "Set, as temporary audio device, the next device in the list of checked devices of the temporary audio device manager".
The second press in a short time, launches the script "Leave up the temporary audio device".
This feature makes it possible to separate the sound of NVDA from the sound of the audio applications launched and thus to hear in one ear the sound of NVDA and in the other ear the sound of other audio applications.
It is installed by default.
Technically, this is to zero the volume level of the right or left audio channels of NVDA and applications.
NVDA being a monaural application, the same sound is played on both channels. There is no phonic audio loss at zeroing a channel.
But this is not the case for stereophonic applications.
To orient the sound of NVDA, the extension installs the following scripts:
No input gesture is assigned to them. But it is still possible to do this using NVDA's "Input Gestures" dialog. These scripts can be found under the "Sound Control" category of the NVDA "Input Gestures" dialog.
The "control+shift+espace" command is operational even if the feature is not installed in order, possibly, to be able to rebalance the audio of certain applications that remained unbalanced after uninstalling the feature.
The dialog "NVDA audio manager and active applications" also allows you to orient the sound of NVDA, but also to set the volume level of the two audio channels of NVDA and applications. He introduces :
When the list is focused, the following commands are allowed:
This list is automatically refreshed when the cursor is given to it.
Channel changeover changes or volume level changes are applied immediately after each command.
By default, the application volume level cannot be greater than the master volume level. But the option "Increase the main volume if necessary" allows to deactivate this limitation. This option can be found in the "Volume modification" group of the "Computer" category of the extension's "Settings" dialog.
Protection is provided to avoid simultaneously zeroing the level of NVDA's audio channels and having its volume level lower than its configured restore threshold.
When an application is selected, the channel balance status is announced along with the mute status.
When restarting NVDA or if the extension is disabled or uninstalled, NVDA is again heard on both audio channels, while applications remain in their state (remembered by Windows).
Note: For proper operation, NVDA and audio applications must use the same audio output device, such as the sound mapper. Moreover, the functionality is only of interest in this case.
To enable or disable extensions, NVDA natively offers the Extension Manager. However in some cases it may be necessary to deactivate some or all of the extensions leaving only a few extensions activated. With the extension manager, it is then necessary to review each extension to activate or deactivate it.
This extension tries to make this manipulation faster and for that, it provides a script to display the "Quick add-ons activation" dialog.
This script is started using the "q" command of the command interpreter. No input gesture is associated with it. But it is possible to do this using NVDA's "input Gestures" dialog. It can be found in the "NVDA global commands extension" category with the description "Activate quick add-ons activation dialog".
This dialogue presents:
The list shows only the add-ons enabled or disabled when the dialog is displayed. Incompatible add-ons, to be activated or deactivated at the next start-up, are not included in the list.
When the dialog is displayed, the activated add-ons are checked.
To change the activation status of an add-on, all you have to do is check it to activate it, or uncheck it to deactivate it.
The changes will only be taken into account when the "Save and restart NVDA" button is pressed.
In Windows ribbons, NVDA is too chatty unnecessarily. By default, this add-on prevents the advertisement of the description which seems quite unnecessary.
But this can be disabled using the "No object description inWindows ribbons" option found in the "Computer" category of the "add-on settings" dialog.
A restart of NVDA will then be necessary for the option to be taken into account.
This option automatically maximizes windows that are brought to the foreground.
By default, it is enabled.
You can deactivate it by unchecking the option "Automatically maximize windows " in the "Computer" category of the "Settings" dialog of the add-on.
NVDA allows you to move word by word in documents using the "control + right arrow" and "control + left arrow" keyboard commands.
The symbols and punctuation marks are then said according to the level of punctuation and symbols configured for the current configuration profile.
This option allows you to configure the level of symbols and punctuation that will be used only when moving by word.
This choice is saved for the current configuration profile.It is configured in the "NVDA enhancement" category of the add-on's "Settings" dialog and named "Punctuation/symbol level on word movement".
It is only present if the "Announcement of the function associated with the" copy "," Paste "style editing commands is installed.
It is presented in the form of a combobox which allows you to choose:
When the "Spelling error" option in the "Document information" group of the "Document formatting" category of NVDA settings is checked, NVDA will sound a special sound for the spelling error that comes from be made.
This sound is emitted just after the hit on the space bar ending the word.
Some users find this sound unpleasant, the extension brings the possibility of replacing this sound either by a double beep, or by the voice announcement "Spelling error".
The choice is made in the group "Reporting spelling errors" of the category "NVDA enhancements" of the global settings of the add-on.
(available for NVDA versions lower than 2023.1 if the "Selective announcement of command keys" feature is installed)
It can be useful in some cases to prevent the action of the "Insert" and "Caps lock" keys.
Their initial role is:
NVDA allows the user to define these keys as "NVDA" key. But in this case, the "Insert" key like the "Caps Lock" key only plays their initial role if there is a quick double press.
By configuration, the add-on gives the possibility that these keys have no action when they are in their initial role.
This configuration is done by configuration profile using one check box per key (See the "Key lock" group in the "Keyboard" category of the current profile).
When the key action is blocked, a beep sounds.
This option allows non-alphanumeric characters to be spoken when keyboard echo by characters is disabled.
This allows some users to hear, for example, typed punctuation symbols, even if they have disabled keyboard echo by character.
It is configured using the "Speak non-alphanumeric characters anyway when keyboard echo by character is disabled" checkbox found in the "Keyboard" category for the current configuration profile.
By default, it is unchecked.
Experienced users may have noticed that when using a development version of NVDA (snapshot master or next version), any error entered in the NVDA log is signaled with a sound. But with final versions or candidate releases, this signal is not emitted.
This option offers the choice between:
To make this choice, all you have to do is select the option in the combobox list named "Play sound on logged errors" in the "Advanced" category of the "Settings" dialog of the add-on. By default, the option "Only for development versions" is selected.
This option allows you to title or not the dialog boxes of this add-on with its name. It can be found in the "Advanced" category of the "Settings" dialog.
By default, this option is checked and the title of the boxes is in the form: "NVDA global commands extension - NVDA - dialog title".
Some scripts in this add-on perform different actions depending on the number of times the input gesture associated with the script is dialed. The repetition of the control gesture must be done within a short time (500 ms by default).
For a script performing three different actions, the mechanism is:
Depending on the user's dexterity or the hardware configuration, this timeout may be too long or too short.
The option entitled "Delay between repeat of same gesture" in the "Advanced" category of the "Settings" dialog of the add-on allows you to adjust this timeout as needed.
By default, NVDA uses certain keys on the numeric keypad, such as the arrow keys, the "multiply", "divide" keys, and the "plus" key, to activate scripts.
The objective is to restore to each key of the numeric keypad, temporarily or permanently, its normal functioning, composed alone or with a modification key such as "control", "Alt", "capital" (The "NVDA" key is excluded).
These keys are:
To enable or disable the use of the numeric keypad in standard operation and if the option "allow the standard use of the numeric keypad" in the "Numeric keypad" grouping of the "Keyboard" category is checked, the add-on offers:
The "Enable the standard use of the numeric keypad at NVDA's start" option ("Numeric keypad" grouping, " Keyboard " category), allows, if it is checked, to use the numeric keypad as standard from the start of NVDA , but the option that allows standard use of the numeric keypad must also be checked.
This feature is partly taken from the "sharedComputer" add-on (authors "Robert Hänggi <aarjay.robert@gmail.com>, Noelia Ruiz Martínez <nrm1977@gmail.com>" which seems not to have been updated since 2018 .
It consists of:
By default and in "Desktop" keyboard layout, the add-on reports that Numeric Lock is enabled when starting NVDA.
But this can be disabled, as is the default for the "laptop" keyboard layout, using the "Report enabled state when NVDA starts" option in the "Numeric Lock" group of the "Keyboard" category of the add-on settings.
Each time a configuration profile is activated, it is possible to automatically activate or deactivate the numeric lock.
The choice is made in the settings of the configuration profile, in the "Keyboard" category of the "Numeric lock" group and with the list of choices "On activating the profile: ".
This list offers the following choices:
By default, the choice is:
When a key is pressed and not released quickly enough, Windows generates a series of keypresses which can be annoying especially in an editing area.
This feature attempts to keep this number of key presses to a minimum.
It is controlled by the "Limit repetitions" checkbox which is in the "Keystroke repetition" group of the "Advanced" category of the global parameters of the add-on and by the repetition delay which is configured in the same group.
When this option is checked, any new press of the same key that occurs within a delay less than the configured repeat delay is ignored.
By default, this box is unchecked and the snooze delay is set to 100 milliseconds
It is not possible to keep only the first key press because the delay with the following key press is too great (around 500 milliseconds).
Modifier keys are not affected by this limitation.
This add-on adds in the "tools" menu of NVDA a sub-menu "Explore NVDA" which offers two choice items:
Two scripts, placed in the "NVDA global commands extension" category of the NVDA "input gestures" dialog, are provided to perform these same actions and with the following descriptions:
By default, no input gesture is associated with them.
Basically, a double press of the "NVDA + f" input gesture presents the formatting information in the form of an HTML document.
This script aims to complete them and display them instead in a dialog box so that they can be read using the arrows keys.
It is started using the "f" command of the interpreter.
The description of the script is: "Display formatting info for the current review cursor position within a document in dialog box".
It is stored under the "NVDA global commands extension" heading of the "NVDA input gestures" dialog.
No input gesture is assigned to it by default.
NVDA considers some dialog boxes, such as confirmation dialogs, that the text they contain is a description.
So if the "Announce object description" option in the "Object overview" category of the NVDA "Settings" dialog is not checked, the text is not announced by NVDA.
This add-on implements the "Do not take account of the option called Report object descriptions during the display of the dialog box style confirmation" option in the "Advanced" category of the "Settings" dialog of the add-on to force, if checked, the announcement of the text of these boxes in all cases. This option is checked by default.
The NVDA "Input gestures" dialog allows you to configure the input gestures (keyboard shortcuts, braille display buttons, etc.) for the scripts (called commands in the NVDA user manual) available at this time. For more information, see the "Input gestures" chapter of this manual.
The extension makes it possible to execute scripts in this dialog, even if no input gesture is configured.
It modifies this dialog by adding the "Execute the script" button when a script is selected in the tree view.
The script can be executed using one of the following three actions:
By repeating the action several times quickly, the script will be executed as many times.
It may happen that we need to open the "Input gestures" dialog to know the input gestures provided by the active extension for the application under focus.
Without extension, the first category is selected by default.
In order to save time, the extension brings the selection of the category associated with the active extension for the application under focus.
It does this by looking for the category among the categories that provide scripts belonging to the active extension. But the latter can set up scripts in any category.
This category will then be automatically selected and expanded.
NVDA's "NVDA + control + right or left arrow" input gestures allow you to jump from one setting to another in the synthesizer's settings ring.
But after restarting NVDA, the last used setting is forgotten.
This improvement attempts to overcome this drawback.
To do this, the add-on saves, at each movement in the synthesizer settings ring, the last setting used for each synthesizer and for each configuration profile.
This setting will then be selected again when NVDA starts up for the synthesizer and for the "normal configuration" profile or when profiles switching.
Warning: like all NVDA parameters, it is necessary that the NVDA configuration is saved before restarting NVDA (either automatically or manually) in order to find them after the restart.
The add-on brings the following scripts When the cursor is in the folder tree:
This script allows, when the cursor is positioned on one of the elements of the folder n of the Windows explorer tree, to:
No input gesture or interpreter command is assigned to it by default.
The description of the script is: "Announce the reduced path of the folder or file under the cursor of Windows Explorer. Two presses: announce the full path. Three presses: copy the full path to the clipboard".
It is stored under the "NVDA global commands extension" section of the "input Gestures" NVDA dialog.
It is possible to associate a input gesture to it using this dialog.
The number of folders to keep for the reduced path is configurable (see the "Windows Explorer" group of the "Computer" category of the add-on's global settings. By default, this number is 4).
This script, like the one announcing the reduced path, allows you to locate the element under the cursor without having to hear all the names of the folders that make up the full path.
Unlike the other script, it is not limited by the configuration, ie the number of path folders to keep.
It announces the name of the folders making up the path in the opposite direction, ie going up the tree of folders. This announcement can be stopped at any time by pressing the "Control" key.
For example, if the selected item is in folder n, NVDA will announce in the following order:
The option "Report folder name of reversed path with level" makes it possible not to announce the level of the folders. It is in the "Windows Explorer" group of the "Computer" category.
No input gesture or interpreter command is assigned by default to this script.
The description of this script is: "Announce the path of the file or folder under the cursor of Windows Explorer going up the tree structure of folders".
It is stored under the "NVDA global commands extension" section of the "Input Gestures" NVDA dialog.
It is possible to associate a input gesture to it using this dialog.
Desktop computer | Laptop | Touch | Description |
NVDA+j | NVDA+j | None | Start the add-on command interpreter |
nvda+, | nvda+, | none | make a single left click at the position of the navigator object. The second press makes a double click |
nvda+majuscule+, | nvda+majuscule+, | none | right-click at the position of the navigator object. The second press makes a double click |
Order | Description |
a | Display informations about the focused application |
b | Display the list's visible items making up current foreground object |
c | Show Temporary Audio Device Manager |
shift+c | Set, as temporary audio device, the next device in the list of checked devices in the temporary audio device manager |
control+c | Discard temporary audio device |
d | Copy date and time to the clipboard |
e | Display running add-ons list |
f | Display formatting info for the current review cursor position within a document in dialog box |
f1 | Display add-on settings dialog |
control+f1 | Show extension settings dialog for current configuration profile |
f2 | Display keyboard key renaming dialog |
f3 | Display command key selective announcement dialog |
f4 | Allow you to copy or type complex symbol |
control+f4 | Display the list of last used symbols |
f5 | Enable or disable the standard use of numeric keypad |
f6 | Enable or disable text analyzer |
shift+f6 | Analyze word under system cursor |
control+f6 | Analyze Line Under System Cursor |
windows+f6 | Analyze sentence under system cursor |
shift+control+f6 | Analyze paragraph under system cursor |
f7 | Enable/disable the announcement of the current cursor position in an edit box |
f8 | Display NVDA and applications channels manager dialog |
f9 | display speech history records |
F10 | Display the running application windows's list with opportunity to put one of them on the foreground or destroy it |
F11 | Shows the list of buttons on the System Tray |
f12 | Display dialog to start the minute timer.If minute timer already started, display dialog to report duration |
g | Display add-on user's guide |
h | Display the commands of the commands interpreter |
j | Open a dialog to manage NVDA logs |
k | Close all opened windows |
n | Show dialog to manage user configurations |
o | report the name of current selected folder in the open or Save dialog box |
p | Toggle voice profile switch mode |
q | Activate quick add-ons activation dialog |
r | Display dialog to shut down, reboot or hibernate the computer |
s | Toggle current focused application volume mute |
control+s | Set on main and NVDA volume |
t | Display tools for add-on development dialog |
u | Displays the dialog to manage the input gestures configured by user |
v | Display dialog to manage voice profile selectors |
x | Add selected text to clipboard |
contrôle+x | Clear clipboard |
z | Report current speech settings |
control+z | Display current speech settings |
upArrow | Increase the volume of the application under focus |
shift+upArrow | Increase the NVDA volume |
control+up arrow | Increase master volume |
downArrow | Decrease the volume of the application under focus |
shift+downArrow | Decrease the NVDA volume |
control+down arrow | Decrease the main volume |
pageUp | Maximize the volume of the application under focus |
shift+pageUp | Maximize the NVDA volume |
control+page up | Maximize the main volume |
pagDown | Minimize the volume of the application under focus |
shift+pageDown | Minimize the NVDA volume |
control+page down | Minimize the main volume |
backSpace | Set the volume of the application under focus to the previous level |
shift+backSpace | Set the NVDA volume to the previous level |
control+backspace | Set main volume to previous level |
number from 1 to 9 | Set the volume of the application under focus to x percent of the main volume (x equal to 10 multiplied by the number) |
shift + number from 1 to 9 | Set to x the NVDA volume (x equal to 10 multiplied by the figure) |
control + number from 1 to 9 | Set to x the main volume (x equal to 10 multiplied by the figure) |
leftArrow | Hear NVDA on the left and focused application on the right |
control+leftArrow | Hear NVDA on the left and all applications on the right |
rightArrow | Hear NVDA on the right and focused application on the left |
control+rightArrow | Hear NVDA on the right and all applications on the left |
space | Hear NVDA and focused at the center |
control+space | Hear NVDA and all applications at the center |
control+shift+espace | Hear focused application at the center |
Desktop computer | Laptop | Touch | Description |
NVDA+F11 | NVDA+F11 | None | Shows the list of buttons on the System Tray. Twice, Display the running application windows's list with opportunity to put one of them on the foreground or destroy it |
Desktop computer | Laptop | Touch | Description |
NVDA+shift+f4 | NVDA+shift+f4 | None | Allow you to copy or type complex symbol |
Desktop computer | Laptop | Touch | Description |
NVDA+shift+f1 | NVDA+shift+f1 | None | Report the application 's name and version |
NVDA+control+F1 | NVDA+control+F1 | None | Speaks the filename of the active application along with the name of the currently loaded appModule python file. Pressing this key twice,speak the name and state of the current configuration profile |
Desktop computer | Laptop | Touch | Description |
NVDA+alt+j | NVDA+alt+j | none | Report current table row's cells |
NVDA+alt+l | NVDA+alt+l | none | Report current table column's cells |
NVDA+alt+down arrow | NVDA+alt+down arrow | none | Move to and report next table row |
NVDA+up arrow | NVDA+up arrow | none | Move to and report previous table row |
NVDA+alt+right arrow | NVDA+alt+right arrow | none | Move to and report next table column |
NVDA+alt+left arrow | NVDA+alt+left arrow | none | Move to and report previous table column |
NVDA+alt+numpad5 | NVDA+alt+; | none | Report current table cell position |
control+alt+shift+left arrow | control+alt+shift+left arrow | none | Move to first cell of table row |
control+alt+shift+right arrow | control+alt+shift+right arrow | none | Move to last cell of table row |
control+alt+shift+up arrow | control+alt+shift+up arrow | none | Move to first cell of table column |
control+alt+shift+down arrow | control+alt+shift+down arrow | none | Move to last cell of table column |
NVDA+a | NVDA+shift+a | none | Report document 's address (URL). Twice: copy it to clipboard |
Desktop computer | Laptop | Touch | Description |
NVDA+o | NVDA+o | None | report the name of current selected folder in the open or Save dialog box. Twice: report full path |
Desktop computer | Laptop | Touch | Description |
NVDA+shift+j | NVDA+shift+j | None | Open current NVDA log file. Pressing this key twice, open the old NVDA log file. Pressing third, copy current log path to the clipboard |
Desktop computer | Laptop | Touch | Description |
NVDA+control+f8 | NVDA+control+f8 | None | Report previous record of the speech history and copy it to clipboard |
NVDA+control+f10 | NVDA+control+f10 | None | Report next record of the speech history and copy it to clipboard |
NVDA+control+f9 | NVDA+control+f9 | None | Report current record of the speech history and copy it to clipboard. Twice: display speech history |
Desktop computer | Laptop | Touch | Description |
NVDA+shift+f12 | NVDA+shift+f12 | None | Display dialog to start the minute timer.If minute timer already started, display dialog to report duration |
Desktop computer | Laptop | Touch | Description |
NVDA+control+f4 | NVDA+control+f4 | None | Restart NVDA. Twice: restart with log levelset to debug |
Desktop computer | Laptop | Touch | Description |
NVDA+b | NVDA+b | None | Reads all controls in the active window. If pressed twice: display the list's visible items making up it |
Desktop computer | Laptop | Touch | Description |
nvda+shift+control+selector number | nvda+shift+control+selector number | None | Set selector x as current selector and Sets , if possible, it associated voice profile as current voice profile (x equals number 1 to 8) |
nvda+shift+control+right arrow | nvda+shift+control+right arrow | None | Go to forward to the first selector associated to a voice profile and set this voice profile as current voice profile |
nvda+shift+control+left arrow | nvda+shift+control+left arrow | None | Go backward to the first selector associated to a voice profile and set this voice profile as current voice profile |
nvda+shift+control+m | nvda+shift+control+m | None | Display dialog to manage voice profile selectors (command: v) |
nvda+majuscule+control+p | nvda+majuscule+control+p | none | Activate or deactivate Voice profile switching mode |
Desktop computer | Laptop | Touch | Description |
NVDA+F12 | NVDA+F12 | none | Reports the current time. Twice, reports the current date. Third: copy date and time to the clipboard |
Desktop computer | Laptop | Touch | Description |
NVDA+shift+f6 | NVDA+shift+f6 | none | Analyze word under cursor |
NVDA+control+f6 | NVDA+control+f6 | none | Analyze Line Under Cursor |
NVDA+windows+f6 | NVDA+windows+f6 | none | Analyze sentence under cursor |
NVDA+shift+control+f6 | NVDA+shift+control+f6 | none | Analyze paragraph under cursor |