Looking for "code documentation" for making NVDA add-ons
|
David Lenton
We are in process of trying to understand NVDA "add-on" with the aim to produce add-ons of our own design and have been following the information provided in NVDA 2022.4 Developer Guide.
In section 3.1 in the last paragraph it states Developers should consult the code documentation for a complete reference. We have done searches but cannot find this documentation and expected it might be on GitHub but have had no luck so far. Could anyone advise where to look. Thank you |
|
|
|
Christopher Duffley
Have you considered looking at the NVDA Add-On Development Guide and also the Design Overview document? There’s a heck of a lot of info that should be more than sufficient for getting it. You can also read the source code itself to see what’s there for you to use.
Cheers, Chris
From: nvda@nvda.groups.io <nvda@nvda.groups.io> On Behalf Of David Lenton
Sent: Monday, March 20, 2023 21:18 To: nvda@nvda.groups.io Subject: [nvda] Looking for "code documentation" for making NVDA add-ons
We are in process of trying to understand NVDA "add-on" with the aim to produce add-ons of our own design and have been following the information provided in NVDA 2022.4 Developer Guide. |
|
|
|
This query might get more traction on either of the following two groups:
NVDA Add-On Developers Group, AKA NVDA Add-Ons Central This group is focused on the development of NVDA Add-Ons. It is not an end-user support group.
NVDA Developers Group This group is focused on the development of the NVDA Screen Reader. It is not an end-user support group.
-- Brian - Virginia, USA - Windows 11 Pro, 64-Bit, Version 22H2, Build 22621; Office 2016, Version 16.0.15726.20188, 32-bit It is much easier to be critical than to be correct. ~ Benjamin Disraeli, 1804-1881 |
|
|
|
Hi, Can you tell us more about the kinds of NVDA add-ons you are interested in creating? That way we can direct you to more appropriate places to ask and/or read things, including source code for various NVDA add-ons. Cheers, Joseph |
|
|
|
coscell@...
How about to change something which displayed on braille display?
toggle quoted message
Show quoted text
For instance to separate Chinese and English characters with a space. On Mon, 20 Mar 2023, Joseph Lee wrote:
Date: Mon, 20 Mar 2023 20:41:39 -0700 |
|
|
|
Hi, If talking about displaying text from somewhere, than this would be more towards Liblouis thing rather than a standard braille display module for NVDA. Cheers, Joseph |
|
|
|
coscell@...
Not Liblouis. I think just braille.py is enouh. But I don't understand many things so I need more tutorials to apply braille.py. Are there examples?
toggle quoted message
Show quoted text
On Mon, 20 Mar 2023, Joseph Lee wrote:
Date: Mon, 20 Mar 2023 21:50:53 -0700 |
|
|
|
Hi, Not that I know of at this point as that module is responsible for braille output and braille display management. Cheers, Joseph |
|
|
|
David Lenton
Thanks Joseph. One of the advantages of the touch keyboard is that you can explore the keyboard with your finger and find the correct key you want before tapping it and sending it through to the current application. However, with the physical keyboard you don't know what key your finger is on until you have pressed the key and if it is the wrong key then you have to press backspace to delete it and find the correct key again. I want to have an add-on that fixes this problem by letting you press a key on the physical keyboard and have the key / key combination, read out followed by a description of what that key / key combination does (when applicable) without sending the key / key combination through to the application, just like when input help mode is on. The difference between this new add-on and input help mode would be that once you have found the correct key to press, you can press it again to actually send the key or key combination through to the application. I would like to learn about add on creation so I can create this add on. I have a laptop with a 360 degree hinge that can make it turn into a tablet and I would use the touch keyboard but I am having several problems with using the touch keyboard. One example is that such as it randomly disappears while I type or edit text and also the arrow keys not working when NVDA is on. |
|
|
|
Hi, I see, something like a keyboard input toggle that will announce keys the first time, then enter the actual key when pressed a second time. This will involve input processing, specifically input core and keyboard handler modules from NVDA (unless I'm wrong). Also, there could be softwaer out there that could be used for this purpose, and if so and such a software is accessible by screen readers, then there may not be a need for an NVDA add-on. If there is one thing I have learned while maintaining add-ons for close to a decade, it is that there are times and situations where an add-on is unnecessary - either due to people not knowing such a thing exists in NVDA, misunderstandings between users and app developers, or a software that performs what the add-on is being requested for already exists. But there are indeed times when an add-on or two is genuinely needed, such as demonstrating for a need for accessible software, accessing services provided somewhere, supporting assistive hardware (mostly braille displays), adding speech synthesizers, and providing solutions specific to screen reader users and/or improving productivity in specific situations. Cheers, Joseph |
|
|