Difference between revisions of "Accessibility On Windows"

From Mudlet
Jump to navigation Jump to search
(Added a quick paragraph about turning mouse tracking off in NVDA.)
 
(3 intermediate revisions by 2 users not shown)
Line 9: Line 9:
 
[https://support.microsoft.com/en-us/windows/hear-text-read-aloud-with-narrator-040f16c1-4632-b64e-110a-da4a0ac56917 Narrator] is a screen reader that is built into windows. To enable it, simply press CTRL+Windows Logo Key+Enter. When you do, speech should start almost immediately.
 
[https://support.microsoft.com/en-us/windows/hear-text-read-aloud-with-narrator-040f16c1-4632-b64e-110a-da4a0ac56917 Narrator] is a screen reader that is built into windows. To enable it, simply press CTRL+Windows Logo Key+Enter. When you do, speech should start almost immediately.
  
−
==NVDA==
+
==NVDA (Nonvisual Desktop Access)==
  
 
===General Information===
 
===General Information===
Line 18: Line 18:
  
 
The main toolbar can be reached with object navigation, and the items there can be activated by use of NVDA's default action key. This would be NVDA+Numpad Enter in the desktop layout and NVDA+Enter in the laptop layout.
 
The main toolbar can be reached with object navigation, and the items there can be activated by use of NVDA's default action key. This would be NVDA+Numpad Enter in the desktop layout and NVDA+Enter in the laptop layout.
 +
 +
 +
It is also advisable to turn Mouse tracking off. This can be done with NVDA+M, and is also accessible within the mouse category of NVDA's settings. This should prevent a nasty freeze that can leave computers inoperable for minutes at a time.
 +
 +
 +
 +
===Accessing Toolbars In the Editor===
 +
 +
While it is possible to use object navigation to reach the toolbars in the editor, it is not an optimal solution. This is most evident in the trigger editor, where the navigator must traverse 150+ controls to reach them. Instead, an NVDA addon exists that can speed this process along.
 +
 +
[https://addons.nvda-project.org/addons/toolbarsExplorer.en.html Toolbar Explorer] enables navigation of any toolbars that are found in a given window. Once a toolbar is selected, it is possible to navigate to, and click on any buttons associated with the selected toolbar.
 +
 +
It's as easy as pressing ALT+applications key from within the editor window. then using the left and right arrows to move between the toolbars, and up and down to move through the buttons in the previously selected toolbar. Enter will perform a standard press of the button and cancel out of toolbar navigation mode. If your keyboard does not have an application key, this gesture can be reassigned in the standard way. It can be found under the object navigation category. The addon's page also contains more usage information than is covered here.
  
 
===Entering Lua Code===
 
===Entering Lua Code===
  
−
Currently, the editor that handles [https://www.lua.org/ Lua] is not accessible to screen readers; however, there is a work-around for those willing to write their code in an external editor and paste it into the [https://www.edbee.net/ Edbee] applet, which currently appears as an unnamed grouping for screen reader users. This trick requires that [https://addons.nvda-project.org/addons/goldenCursor.en.html Golden Cursor] be installed, which is a popular addon for VDA.
+
Entering code into the lua box in the editor is very similar to using any other text editor, with the exception that you will have the option to autocomplete Mudlet functions as you type them. For instance, let's say we want to fire off a timer, so we start typing:
 +
<code>tempT</code> At some point, suggestions will be offered, arrowing through them is possible, to accept one of them, just press tab. In the previous example, it is not necessary to type tempTimer in full.
 +
 
 +
The tab key also enters a number of spaces to indent code. Because of its use in this manner, it is not possible to use tab to break out of the editor's influence. However, CTRL+Tab works for this purpose.
 +
 
 +
N.B. The lua box will maintain the level of indent until told to change. This means if lines 1-3 are not indented, but line 4 is, when entering more lines, 5 and up will be indented to line 4's level. When working with blocks of code, this is exactly what makes it nice to use. To decrease a line's level of indent, navigate to it and press SHIFT+TAB.
 +
 
 +
===Blank lines===
 +
Accessibility for Mudlet for Windows has an issue reporting blank lines to screen readers properly. Narrator deals OK with this, while NVDA will repeat the same lines again. To alleviate this, go to Preferences - Special Options - and change 'when a game sends blank lines' to either 'hide them' or 'replace with space'.
  
−
#Either create a new trigger, alias, etc. or select one you wish to edit
+
==JAWS for Windows (Job Access With Speech)==
−
#Prepare some Lua code in an external editor such as
 
−
##[https://www.flos-freeware.ch/notepad2.html Notepad2]
 
−
##[https://notepad-plus-plus.org/ Notepad++]
 
−
##[https://code.visualstudio.com/ Visual Studio Code]
 
−
#Invoke NVDA's mouse settings dialog by pressing NVDA+CTRL+M
 
−
#Ensure that the following two options are checked
 
−
##Report mouse shape changes
 
−
##Enable mouse tracking
 
−
#Click, "OK" to save and close, or, "Apply", to save and leave the window open
 
−
#Go to your external editor of choice and copy your code into the clipboard
 
−
#Return to the Mudlet editor and tab until you hear, "Grouping"
 
−
##Optionally, if you pressed tab too many times, you will now be inserting tabs into the editor, press backspace a few times to clear them
 
−
#You should now explore around the area with Golden Cursor's mouse movement keys until you hear that the cursor has become an, "Edit cursor"
 
−
#Route the mouse cursor to the grouping by pressing +Numpad slash or NVDA+Shift+M for laptop layout users
 
−
#Use NVDA + [ (left square bracket) to perform a mouse click.
 
−
#Press CTRL+V to paste the code
 
−
#Press NVDA+R to perform optical character recognition (OCR) on the grouping to ensure the code was pasted
 
−
#Press CTRL+Tab to jump outside of the editor
 
  
−
Precise instructions can't be given on how to find the point at which the cursor changes to the correct shape because of varying screen resolutions; however, once found, a mouse position can be saved in Golden Cursor and used at a later time to jump the mouse inside the applet.
+
While it's possible to use Mudlet with JAWS, there is an issue making it an impractical solution. That being that JAWS is not reading the output window like other screen readers do. The [https://github.com/tspivey/mudlet-reader Reader package] can help with this, but only to a limited extent. It is not possible to select and copy text, therefore, it is recommended to use another screen reader, such as Narrator or NVDA in conjunction with Mudlet, rather than JAWS.

Latest revision as of 15:03, 11 July 2024

Introduction

On this page, you will find information for the screen readers that Mudlet is able to work with on Windows. They are: Narrator, Jaws For Windows, and NVDA.

Narrator

General Information

Narrator is a screen reader that is built into windows. To enable it, simply press CTRL+Windows Logo Key+Enter. When you do, speech should start almost immediately.

NVDA (Nonvisual Desktop Access)

General Information

NVDA or NonVisual Desktop Access is a free, third party screen reader that works on Windows. Those wishing to use Mudlet with NVDA should be familiar with the review cursor, and with object navigation. Information on both of these topics can be found in the NVDA User Guide as well as in Commands Quick Reference. The latter can be found in NVDA's help menu, accessible by pressing NVDA + N followed by the letter H.

those planning to use the review cursor in the output window should be aware that the option, "Simple review mode", should be turned on. This option can be fount in the review cursor tab, in NVDA's settings dialog. If having this turned on becomes a hindrance when using other software, a configuration profile for Mudlet can be created in which this option can be turned on as long as the Mudlet window had focus prior to invoking the settings dialog. As with all other application specific configuration profiles, the profile will automatically deactivate when focusing any other application than the one the profile was created for.

The main toolbar can be reached with object navigation, and the items there can be activated by use of NVDA's default action key. This would be NVDA+Numpad Enter in the desktop layout and NVDA+Enter in the laptop layout.


It is also advisable to turn Mouse tracking off. This can be done with NVDA+M, and is also accessible within the mouse category of NVDA's settings. This should prevent a nasty freeze that can leave computers inoperable for minutes at a time.


Accessing Toolbars In the Editor

While it is possible to use object navigation to reach the toolbars in the editor, it is not an optimal solution. This is most evident in the trigger editor, where the navigator must traverse 150+ controls to reach them. Instead, an NVDA addon exists that can speed this process along.

Toolbar Explorer enables navigation of any toolbars that are found in a given window. Once a toolbar is selected, it is possible to navigate to, and click on any buttons associated with the selected toolbar.

It's as easy as pressing ALT+applications key from within the editor window. then using the left and right arrows to move between the toolbars, and up and down to move through the buttons in the previously selected toolbar. Enter will perform a standard press of the button and cancel out of toolbar navigation mode. If your keyboard does not have an application key, this gesture can be reassigned in the standard way. It can be found under the object navigation category. The addon's page also contains more usage information than is covered here.

Entering Lua Code

Entering code into the lua box in the editor is very similar to using any other text editor, with the exception that you will have the option to autocomplete Mudlet functions as you type them. For instance, let's say we want to fire off a timer, so we start typing: tempT At some point, suggestions will be offered, arrowing through them is possible, to accept one of them, just press tab. In the previous example, it is not necessary to type tempTimer in full.

The tab key also enters a number of spaces to indent code. Because of its use in this manner, it is not possible to use tab to break out of the editor's influence. However, CTRL+Tab works for this purpose.

N.B. The lua box will maintain the level of indent until told to change. This means if lines 1-3 are not indented, but line 4 is, when entering more lines, 5 and up will be indented to line 4's level. When working with blocks of code, this is exactly what makes it nice to use. To decrease a line's level of indent, navigate to it and press SHIFT+TAB.

Blank lines

Accessibility for Mudlet for Windows has an issue reporting blank lines to screen readers properly. Narrator deals OK with this, while NVDA will repeat the same lines again. To alleviate this, go to Preferences - Special Options - and change 'when a game sends blank lines' to either 'hide them' or 'replace with space'.

JAWS for Windows (Job Access With Speech)

While it's possible to use Mudlet with JAWS, there is an issue making it an impractical solution. That being that JAWS is not reading the output window like other screen readers do. The Reader package can help with this, but only to a limited extent. It is not possible to select and copy text, therefore, it is recommended to use another screen reader, such as Narrator or NVDA in conjunction with Mudlet, rather than JAWS.

Retrieved from "https://wiki.mudlet.org/index.php?title=Accessibility_On_Windows&oldid=21763"