JAWS Scripts For Visual Studio Code
Doug Lee and Jeff Bishop
Last Revised March, 2024
This document describes the JAWS scripts for Visual Studio Code and provides
tips for using this application with JAWS.
This document can be opened from within the application via a double press
of JAWSKey+F1 (or Insert+F1)
when the scripts are running.
Table of Contents
System Requirements For JAWS Users
In addition to any system requirements for the application, the following
apply for JAWS users:
- The computer should be running Windows 10 or later.
Older Windows versions may also work but have not been tested.
- JAWS 2021 or later should be used. The scripts will not work with or install into older JAWS versions.
Script Installation Instructions
To install these scripts on a new system:
- Install JAWS if this has not already been done. This will require
administrative privileges on the computer.
- Run JAWS as the user for whom the scripts are to be installed.
This and the following steps must be performed for each user of the computer
who will be using JAWS with these scripts.
- Download and run, or run directly, the installer for
these scripts; and follow the on-screen directions. Be sure to install the scripts in the currently running
JAWS version if a JAWS version list is presented.
- To verify successful installation, type Insert+Q from
within the application. Part of the JAWS spoken response should be a
revision number. If you do not hear a revision number, the scripts are
not correctly loaded.
In some cases, restarting JAWS may fix this issue.
If the installer displayed an error message, and/or JAWSKey+Q does not include the word "Revision,"
it may be necessary to install the scripts manually:
Details on how to install manually
- Download vscode.zip,
which includes all the files in the installer plus two files that the installer would build when run.
- Unpack the downloaded Zip file into your active JAWS version's script folder.
For JAWS 2024, this is normally
%APPDATA%\Freedom Scientific\JAWS\2024\Settings\enu.
The folder can also be opened in Windows Explorer by following these steps:
- Activate the JAWS menu via Insert+J, or for laptop layout, JAWSKey+Ctrl+Shift+J.
- Activate the JAWS menu via Insert+J, or for laptop
layout, JAWSKey+Ctrl+Shift+J.
- Navigate with the Down arrow to Utilities and press Enter.
- Navigate to "Explore Utilities Folder," which can be done most quickly with the Up arrow, and
press Enter. This will open a folder of shortcuts.
- From this folder, press Enter on "Explore My Settings."
Note that the just-opened Utilities folder will remain open in its own window until closed.
Script Commands and Features
These scripts provide the following commands and features beyond those provided by JAWS and the application:
- The standard JAWS command for reading the bottom or status line of the active window,
Insert+PgDn or JAWSKey+PgDn,
will announce the row and column position of the cursor within an editor window.
- JAWS will say "Status bar" when the status bar or one of its controls gains focus.
- JAWSKey+Shift+E will report any error or unusual conditions recently encountered by the scripts.
This command is intended for use with script developers to diagnose any problems that may occur as the
scripted application evolves.
- JAWSKey+Q, along with announcing the active configuration name, will announce the revision number
of these scripts.
- Insert+F1, typed twice in quick succession, opens this document in the default browser.
Known Issues
The following issues are known and may be encountered during use of the application with these JAWS scripts.
These issues may be fixed in a future update to the scripts or to the application itself.
Braille support is not well tested and is likely incomplete.
.hist
Revision History
This is the revision history of these scripts, most recent revision first:
Revision 11, released March 11, 2024
This is a re-release of the same scripts but with an alternative method of installation for anyone for whom
the normal installer does not work as expected.
Several reports of such incidents were received on the day of release, resulting in the initial release
being retracted over the weekend while a resolution could be established.
(A number of people were using a version of these scripts that had been distributed prior to this
collaboration, and the installer for these scripts was suspected of interacting unfavorably with that
setup.)
Anyone who received error messages and did not find scripts, and who are unable to use the script installer,
should follow the new instructions for manual script installation.
If you were previously using the scripts distributed without an installer, this will restore functionality
while installing the new scripts.
This author (Doug Lee) believes that the installation problems experienced were, in most if not all cases, caused by a
collision between script versions that is unique to this project.
However, any users for whom VBScript is not available would also need to install the scripts manually.
Further details about this issue appear in a separate document,
"Installation Issues With the JAWS Scripts For Visual
Studio Code."
Changes in this release:
- There is a Zip version of the script files alongside the installer. The Zip includes two files that the
installer normally builds when running.
- This document's Script Installation Instructions section includes information on
manual script installation.
- Any future releases of these scripts will, until otherwise indicated, include the new Zip file in case
of need.
Revision 9, released March 8, 2024
- Initial collaborative script release.