Hi,

This addon is alread created:

NVDA global Extension

Às 16:28 de 20-06-2022, Noah Carver escreveu:

Dear List,

A particular feature which I have found quite useful in JAWS is the Text Analyzer, which checks for various errors including extra spaces, unmatched opening and closing symbols, font changes, ETC. and notifies the user so that they may fix the mistake. This feature would be immensely helpful for NVDA users, and I am therefore requesting an add-on which adds this functionality. The documentation describing the text analyzer is pasted below, fully describing how the functionality operates, its configuration options, ETC.

If any developer would be interested in creating this add-on, it would not only be appreciated by me, but also by many NVDA users who write often. Thank you for your time and interest.

Sincerely,

Noah

--Documentation starts here--

Text Analyzer Group

When editing a document using speech only, inconsistencies such as unmatched parentheses, unintentional format changes, extra whitespace, and stray or unspaced punctuation can often be missed. Text Analyzer is a tool that notifies you of these errors in your document by using a spoken message or WAV file. You can configure JAWS to announce discrepancies by count, by description, or by sound while proofreading the document by line, sentence, paragraph, or Say All command. Braille users will benefit from this since a sound can be emitted before the user has time to read the entire line looking for errors.

Turning On Text Analyzer

Text Analyzer is off by default. To turn it on, do one of the following:

• Use the layered keystroke, INSERT+SPACEBAR, A. By pressing and releasing INSERT+SPACEBAR, and then pressing A, the Text Analyzer can be toggled on or off.
• Open Settings Center (INSERT+F2). In the Search edit box type "text analyzer" without the quotes. Press DOWN ARROW to move to Text Analyzer in the filtered results. Press SPACEBAR to select an alert notification.
• Use Quick Settings (INSERT+V). The process for selecting an alert notification is the same as the Settings Center procedure described above.

Keystrokes

If multiple issues are identified in the document, press ALT+WINDOWS Key+I to move to the next item, or ALT+SHIFT+WINDOWS Key+I to move to the previous item. Note that these keystrokes can still be used even if Text Analyzer is off.

Text Analyzer Options

Use the radio buttons in this group to determine the type of alert used to indicate errors when editing or proofreading a document by line, sentence, paragraph, or Say All command. Select Indicate with Sound to play a WAV file when a formatting error is detected. Select Speak Count to announce the number of inconsistencies in the current text. Select Describe Inconsistencies for a description of the error. The default setting is off.

Indicate Mismatched Symbols

Select this check box to enable the detection of mismatched symbols such as parenthesis, braces, brackets, angle brackets, and quotes. If this check box is cleared, the items in the Symbols to Check group are not available.

Symbols to Check

Select one or more check boxes to search for mismatched parentheses, braces, brackets, angle brackets, or quotes where the equivalent opening or closing symbol is missing. These check boxes are only available when the Indicate Mismatched Symbols check box is selected.

Inconsistencies to Check

Select one or more check boxes to identify inconsistencies with stray punctuation, extra spaces, missing capital letters, or inverted lowercase and uppercase text.

Font Changes to Check

Select one or more check boxes to identify incorrect font changes in the current text including name, size, attributes, and colors.

-- 
Cordiais Cumprimentos
Ângelo Abrantes, Equipa <Portuguesa do NVDA

Sem vírus. www.avast.com

Text Analyzer Group

When editing a document using speech only, inconsistencies such as unmatched parentheses, unintentional format changes, extra whitespace, and stray or unspaced punctuation can often be missed. Text Analyzer is a tool that notifies you of these errors in your document by using a spoken message or WAV file. You can configure JAWS to announce discrepancies by count, by description, or by sound while proofreading the document by line, sentence, paragraph, or Say All command. Braille users will benefit from this since a sound can be emitted before the user has time to read the entire line looking for errors.

Turning On Text Analyzer

Text Analyzer is off by default. To turn it on, do one of the following:

• Use the layered keystroke, INSERT+SPACEBAR, A. By pressing and releasing INSERT+SPACEBAR, and then pressing A, the Text Analyzer can be toggled on or off.
• Open Settings Center (INSERT+F2). In the Search edit box type "text analyzer" without the quotes. Press DOWN ARROW to move to Text Analyzer in the filtered results. Press SPACEBAR to select an alert notification.
• Use Quick Settings (INSERT+V). The process for selecting an alert notification is the same as the Settings Center procedure described above.

Keystrokes

If multiple issues are identified in the document, press ALT+WINDOWS Key+I to move to the next item, or ALT+SHIFT+WINDOWS Key+I to move to the previous item. Note that these keystrokes can still be used even if Text Analyzer is off.

Text Analyzer Options

Use the radio buttons in this group to determine the type of alert used to indicate errors when editing or proofreading a document by line, sentence, paragraph, or Say All command. Select Indicate with Sound to play a WAV file when a formatting error is detected. Select Speak Count to announce the number of inconsistencies in the current text. Select Describe Inconsistencies for a description of the error. The default setting is off.

Indicate Mismatched Symbols

Select this check box to enable the detection of mismatched symbols such as parenthesis, braces, brackets, angle brackets, and quotes. If this check box is cleared, the items in the Symbols to Check group are not available.

Symbols to Check

Select one or more check boxes to search for mismatched parentheses, braces, brackets, angle brackets, or quotes where the equivalent opening or closing symbol is missing. These check boxes are only available when the Indicate Mismatched Symbols check box is selected.

Inconsistencies to Check

Select one or more check boxes to identify inconsistencies with stray punctuation, extra spaces, missing capital letters, or inverted lowercase and uppercase text.

Font Changes to Check

Select one or more check boxes to identify incorrect font changes in the current text including name, size, attributes, and colors.

Not only those but the ding and alert copied to clipboard when you copy link to clipboard no longer is indicated in the latest version and current nvda.
Brian

----- Original Message -----

From: Ibrahim Hamadeh

To: nvda-addons@nvda-addons.groups.io

Sent: Saturday, June 18, 2022 11:41 PM

Subject: Re: [nvda-addons] golden cursor problem

Hi,
The file.gc should be constructed by goldenCursor addon.
it is just a file to preserve the positions of the mouse in specific application.
So if you mean that your file, heartstone.gc
has been created by another instance of goldenCursor addon, and you want to include it in your current addon
Really goldenCursor does not have an import feature
So, you have to copy the file heartstone.gc
then enter the folder of goldenCursor addon
in the root folder of the addon, meaning this folder
you may find a folder named mousePositions
now enter it, and paste your .gc file in it.
If you did not find the folder named mousePositions
then that means, you haven't yet save any positions using the addon
Try to save one positions for any program, say notepad for instance
after that the folder mousePositions, will show up, and you can paste your file in it.
Then restart NVDA, and go on.
 regards
 
 ibrahim

On 6/18/2022 11:05 AM, leglaude wrote:

Hi all,

I try use golden cursor.

 

I have a script it's a file.gc

 

But I not find where I can import file.gc for my application.

 

it's for game heartstone.

the file for golden cursor is heartstone.gc

 

Thanks!

Hello.


You have a pull request that fixes both issues.


https://github.com/ruifontes/tesseractOCR/pull/2


Greetings


Javi Dominguez



El 05/06/2022 a las 23:01, Javi Domínguez via groups.io escribió:

Hello again.

I have run wia-cmd-scanner.exe directly from the command line, in the Windows CMD, and it has worked perfectly.

However from the addon it doesn't work. stderr shows:

b'The system cannot find the specified path.\r\n'

I hope this helps. It's late and I can't do any more research. Tomorrow dawns very early.

Good nitht

Javi

El 05/06/2022 a las 22:24, Javi Domínguez via groups.io escribió:

Hello.

* It is a limitation of the routine to get the complete path of the file...

If you can help bettering the routine, I will be glad!

OK. I'll take a look at that.

* The scanner is recognized as WIA compatible?

what do you mean with "is recognized as WIA compatible"? Yes, the scanner is WIA compliant, other apps recognize it but the addon I don't know, it just doesn't do anything.

* What Windows version?

Windows 10 21H2 (x64) build 19044.1706

* So, I should name each thread differently...

Yes, it would be convenient.

* And, before starting another thread, verify if it is active, right?

I think so. I would wait for the current thread to finish before starting another.


Note that if you assign the new thread to self._thread, the old thread will continue to run until it finishes but you will no longer have a reference to it. You will only be able to access it via threading.enumerate().


You may need a method to kill threads that are stuck or taking too long.


Greetings


Javi


El 05/06/2022 a las 20:34, Rui Fontes escribió:

Hola Javi!


Comments in midle of your message marked with *...


Às 18:47 de 05/06/2022, Javi Domínguez escreveu:

When I try to recognize a file on the desktop two things happen:

1. If this is the first time a file is recognized, it says "file not supported" (tested with PDF and BMP file types). The same file recognized from a folder in Windows explorer works fine.

* It is a limitation of the routine to get the complete path of the file...

If you can help bettering the routine, I will be glad!

2. If another file has been recognized before, it process any file even if it is not of a supported type. In any case, supported type or not, it always shows the result of the previous recognition, not the requested file. Even after manually deleting the oc.txt and ocr-xxx.png files from the addon's images folder, it re-processes the previously requested file.

* It was an error on code... The path of last document was not cleared, so list of ocr-xxx.png file was created again...

On the other hand, recognition from scanner does not work for me. My scanner is HP Scanjet G2410, It may not be supported but the addon does not speak any message about it. The thread that processes this remains active and never terminates. If the script is executed again, another thread is launched that also remains active and so on forever. It is normal for the user, if he does not receive a response, to try to run it again, so you can end up with a lot of active threads.

* The scanner is recognized as WIA compatible?

* What Windows version?

I have the habit of naming the treads that I use to be able to debug better with threading.enumerate(). I have added the line to __init__.py
self._thread.name = "tesseractOCR"
before starting the thread to do these tests.

* So, I should name each thread differently...

* And, before starting another thread, verify if it is active, right?

finally, in terms of user experience, I think you need to give more information about what is happening. Sometimes, if the recognition takes time, the user does not know if it is working correctly or not.

* It is schedulled for next version...


Thanks!


Rui Fontes

Hi all

Thanks for the feedback.
Since the add-on seems to interest at least a few people, I will definitely
ask its inclusion on the community website.
Beforehand, I have to take into account some of the remarks; special thanks
to Lukasz for all these points with details.

Some other points will be included later, e.g. the GUI to choose the
function to patch that I had already in mind.

Cheers,

Cyrille

Hi all,

I try use golden cursor.

 

I have a script it's a file.gc

 

But I not find where I can import file.gc for my application.

 

it's for game heartstone.

the file for golden cursor is heartstone.gc

 

Thanks!

For those of us who do not know, what is this, and how does it help? Are we

proposing that an add on not signed will not be allowed to run?
This could be counter productive.
Brian

--
bglists@...
Sent via blueyonder.(Virgin media)
Please address personal E-mail to:-
briang1@..., putting 'Brian Gaff'
in the display name field.
----- Original Message -----
From: "Noelia Ruiz" <nrm1977@...>
To: <nvda-addons@nvda-addons.groups.io>
Sent: Friday, June 17, 2022 5:35 AM
Subject: [nvda-addons] Investigation: possible approach to sign add-ons with

GPG

Hello:

I find useful and interesting this issue for the planned add-on
datastore:

Ensure add-on release origin is authentic:
https://github.com/nvaccess/addon-datastore/issues/41

I started to sign some .nvda-addon binaries locally, but this was
tedious. Today, for testing, I've used successfully the "Import gpg"
action available on GitHub to sign the binary on GitHub, not locally.
In case someone has suggestions or feedback, you may comment on the
add-on datastore issue or here. I've provided the following links on
the issue:

- manualRelease workflow: a .yaml file used to release add-ons
providing its version and if it's or not a prerelease:
https://github.com/nvdaes/clipContentsDesigner/blob/main/.github/workflows/manualRelease.yaml
- import gpg action:
https://github.com/marketplace/actions/import-gpg
- Release of clipContentsDesigner add-on for testing (containing the
.sig and publicKey.asc files:
https://github.com/nvdaes/clipContentsDesigner/releases/tag/testGpg16.0.0-dev

Cheers

 

Hello all

I am glad to share with you my add-on NVDA Dev & Test Toolbox.
The documentation is under my signature.
Direct download link: https://github.com/CyrilleB79/NVDA-Dev-Test-Toolbox/releases/download/V2.0/nvdaDevTestToolbox-2.0.nvda-addon

The add-on is not totally new but I had never advertised so much about it. If you find some issue or want to make feedback, do not hesitate, replying to this message or on the GitHub repo.
I plan to submit it for the community website if it interests people. As the name indicates, the audience target for this add-on are people developing or testing NVDA or its add-ons.
Let me know what you think.

Cheers,

Cyrille

NVDA Dev & Test Toolbox

• Author: Cyrille Bougot
• NVDA compatibility: 2019.2 and beyond
• Download stable version

This add-on gathers various features for NVDA debugging and testing.

 

Features

• An enhanced restart dialog to specify some extra options when restarting NVDA.
• A toggle script and a backport of NVDA's "Play a sound for logged errors" feature.
• An object property explorer.
• An extended script description mode: when enabled input help mode report information on scripts that have no description.
• Commands to help log reading and analyzing.
• In the Python console workspace, a function to open the source code of an object.
• A command to log the stack trace of the speech.speak function.

 

Enhanced restart dialog

The NVDA+shift+Q command opens a dialog to specify some extra options before restarting NVDA. The options that can be specified correspond to the command line options that can be used with nvda.exe, e.g. -c for config path, --disable-addons to disable add-ons, etc.

 

Play a sound for logged errors

The "Play a sound for logged errors" setting has been introduced in NVDA 2021.3 and allows to specify if NVDA will play an error sound in case an error is logged.

This add-on provides an additional command (NVDA+control+alt+E) to toggle this setting. You can choose:

• "Only in test versions" (default) to make NVDA play error sounds only if the current NVDA version is a test version (alpha, beta or run from source).
• "Yes" to enable error sounds whatever your current NVDA version is.

For NVDA prior to 2021.3, this add-on provides the backport of this feature and the possibility to control it with the keyboard command. The checkbox in the Advanced settings panel is not backported however.

 

Object property explorer

This feature allows to report some properties of the current navigator object without opening the log viewer.

To list the properties of an object, move the navigator object to it and use the following commands:

• NVDA+Shift+LeftArrow or NVDA+Shift+RightArrow: select previous or next property and announce it for the navigator object.
• NVDA+LeftArrow : Announce the navigator object's currently selected property.

The list of the supported properties is the following: name, role, state, value, windowClassName, windowControlID, windowHandle, location, Python class, Python class mro.

This feature is an improvement of NVDA developer guide example 3

If you have installed Speech history review and copying add-on from Tyler Spivey and James Scholes, you may use it to copy and paste the announced property to review it. Review via copy/paste is especially useful for pythonClassMRO since it may be long.

 

Extended script description mode

When the Extended script description mode is active, the input help mode (NVDA+1) is modified as follows. If a script has no description, the script's name and class are reported. If a script has a description, its description is reported as usual. The gesture to activate or deactivate this feature is NVDA+control+alt+D.

Executing a gesture bound to a script without description in input help mode also create an entry for this script in the gesture management dialog. This entry is located in a dedicated category called "Scripts without description (modify at your own risk!)". This allow to easily add, delete or change the native NVDA gestures for these script. Be aware however that it is often intended that such script do not have any description to prevent the user to modify the associated gesture. Indeed, the gesture may be defined to match an application shortcut key. For example the script script_toggleItalic on NVDAObjects.window.winword.WordDocument is bound to control+I and this should not be modified since the gesture is passed to the application to actually execute the shortcut key.

 

Usage example

Control+shift+I also toggle italic in Word, even if it is not natively reported by NVDA. To have the control+shift+I result reported by NVDA as control+I, you should perform the following steps:

• Open a Word document.
• Enable the extended script description mode with NVDA+control+alt+D.
• Enter input help mode with NVDA+1.
• Press control+I to report the italic script and have it added in the gesture dialog.
• Exit input help mode with NVDA+1.
• Open the input gestures dialog.
• In the category "Scripts without description (modify at your own risk!)", select the command "toggleItalic on NVDAObjects.window.winword.WordDocument".
• Add the control+shift+I shortcut and validate.
• If you want, exit the extended script description mode with NVDA+control+alt+D.

Known bug: A script added for a specific class is visible even if gesture manager is opened in another context.

 

Log reading and analyzing commands

A log reader mode provides commands to ease log reading and analyzing. In the log viewer window the log reader is enabled by default, thus log reading commands are available immediately. In another text reading area such as an editor (e.g. Notepad++) or a webpage (e.g. GitHub issue), you need to press NVDA+control+alt+L to enable log reader mode and use its commands. When you are done with log reading and analyzing tasks, you can disable again NVDA+control+alt+L to disable the log reader mode.

The commands available in log reader mode are described hereafter.

 

Quick navigation commands

Single letter command similar to browse mode quick navigation keys allow to move to various type of log messages:

• m: any message
• e: ERROR
• i: IO
• d: DEBUG
• f: INFO
• g: DEBUGWARNING
• w: WARNING

Pressing the single letter moves to the next occurrence of this message. Combining the letter with the shift key moves to the previous occurrence of this message.

 

Opening a file in your editor

When looking at a traceback, you may want to open one of the source files to understand the cause and the context of the issue. Press C to open the source code file corresponding to the current line of the traceback.

For this feature to work, you need to have configured your favorite editor's command. If you are not running NVDA from source, the location of NVDA source code also should have been configured. For more details regarding the configuration, please see the paragraph NVDA Debug & Test Tools configuration.

 

Python console extension

In the console, you can call the following function to view the source code that defines the variable myVar:
openCodeFile(myVar)

For this feature to work, you need to have configured your favorite editor's command. If you are not running NVDA from source, the location of NVDA source code also should have been configured. For more details regarding the configuration, please see the paragraph NVDA Debug & Test Tools configuration.

The openCodeFile functions can be called on objects defined in NVDA's code or on objects defined by add-ons. It cannot be called on objects whose source code is not available such as python builtins.

Below are examples of call in NVDA's code:

• View the definition of the function speech.speech.speak:
  openCodeFile(speech.speech.speak)
• View the definition of the class TextInfo:
  openCodeFile(textInfos.TextInfo)
• View the definition of the method copyToClipboard of the class TextInfo:
  openCodeFile(textInfos.TextInfo.copyToClipboard)
• View the class definition of the focused object:
  openCodeFile(focus)
• Open the file api.py defining the module api:
  openCodeFile(api)

 

Log the stack trace of the speech function

Sometimes, you may want to see which part of the code is responsible for speaking something. For this, you can enable the stack trace logging of the speech function pressing NVDA+control+alt+S. Each time NVDA speaks, a corresponding stack trace will be logged in the log.

Note: You may modify the script's file directly to patch another function. See all instructions in the file for details on usage.

 

NVDA Debug & Test Tools configuration

The log reader commands and the python console extension feature may require a specific configuration. To use functions that allow to view source code in your editor, you should first configure your editor's command line. If NVDA's file need to be viewed and if you are not running from source, you also need to configure NVDA's source code path.

 

Editor's command line configuration

To use the 'open source code' command or the openCodeFile console command, you need first to configure the command that will be called to open the file in your favorite editor. For this, open the NVDA console (NVDA+control+Z) and type the following line and then Enter: config.conf['ndtt']['sourceFileOpener'] = r'"C:\path\to\my\editor\editor.exe" "{path}":{line}' You should of course modify this line according to the real name and location of your editor and the syntax used by it to open files. {path} will be replaced by the full path of the file to open and {line} by the line number where you want the cursor to be set. For Notepad++ for example the command to type in the console would be: config.conf['ndtt']['sourceFileOpener'] = r'"C:\Program Files\Notepad++\notepad++.exe" {path} -n{line}'

 

NVDA source code path configuration

When a file belonging to NVDA's core is listed in the traceback, the line is of the following form: File "config\profileUpgrader.pyc", line 30, in upgrade

If you are not running NVDA from source, you may specify an alternate location where the source file will be found, e.g. the place where you have cloned NVDA source files. In this case, you have to configure the path where you have NVDA source files located.

For this, open the NVDA console (NVDA+control+Z) and type the following line and then Enter: config.conf['ndtt']['nvdaSourcePath'] = r'C:\pathExample\GIT\nvda\source' Of course, replace the path of NVDA source with the correct one.

Be sure however that the version of your source file (e.g. GIT commit) is the same as the one of the running instance of NVDA.

 

Change log

 

Version 2.0

• New feature: Enhanced restart dialog to specify some extra options when restarting NVDA.
• New feature: extended description mode.
• Play error sound feature harmonized between pre and post 2021.3 versions of NVDA.
• New feature: Log reader commands are now available in the log viewer and also optionally in edit fields or webpages.
• New feature: In the Python console, an openCodeFile function is available to view the source code of an object.
• Some features are now disabled in secure mode for security reasons.
• The add-on's compatibility range has been extended (from 2019.2 to 2021.1).
• Releases are now performed with GitHub action instead of appVeyor.

 

Version 1.0

• Initial release.

 

•  

El 18 jun 2022, a las 7:59, Cyrille via groups.io <cyrille.bougot2@...> escribió:

Hi Noelia

According to people's feedback, i.e. if people think that this add-on can be useful, I will open a PR myself against addonFiles to request its integration in the community website.

Regarding the hashtags, I had only planned to put one of them. It seems that you have succeeded in removing them. Thanks!

Cheers,

Cyrille


On Fri, Jun 17, 2022 at 04:37 PM, Noelia Ruiz wrote:

Hi Cyrille:

 

I"ll look at this add-on and, if needed, I"ll open issues on GitHub.

PS: for any reason, your message appears with a lot of hashtags, maybe due to autocompletion tools or something. I"ll try to edit the subject since it"s anoying to read them.

Cheers

Enviado desde mi iPhone

El 18 jun 2022, a las 0:12, Cyrille via groups.io <cyrille.bougot2@...> escribió:

 

Hello all

I am glad to share with you my add-on NVDA Dev & Test Toolbox.
The documentation is under my signature.
Direct download link: https://github.com/CyrilleB79/NVDA-Dev-Test-Toolbox/releases/download/V2.0/nvdaDevTestToolbox-2.0.nvda-addon

The add-on is not totally new but I had never advertised so much about it. If you find some issue or want to make feedback, do not hesitate, replying to this message or on the GitHub repo.
I plan to submit it for the community website if it interests people. As the name indicates, the audience target for this add-on are people developing or testing NVDA or its add-ons.
Let me know what you think.

Cheers,

Cyrille

NVDA Dev & Test Toolbox

• Author: Cyrille Bougot
• NVDA compatibility: 2019.2 and beyond
• Download stable version

This add-on gathers various features for NVDA debugging and testing.

 

Features

• An enhanced restart dialog to specify some extra options when restarting NVDA.
• A toggle script and a backport of NVDA's "Play a sound for logged errors" feature.
• An object property explorer.
• An extended script description mode: when enabled input help mode report information on scripts that have no description.
• Commands to help log reading and analyzing.
• In the Python console workspace, a function to open the source code of an object.
• A command to log the stack trace of the speech.speak function.

 

Enhanced restart dialog

The NVDA+shift+Q command opens a dialog to specify some extra options before restarting NVDA. The options that can be specified correspond to the command line options that can be used with nvda.exe, e.g. -c for config path, --disable-addons to disable add-ons, etc.

 

Play a sound for logged errors

The "Play a sound for logged errors" setting has been introduced in NVDA 2021.3 and allows to specify if NVDA will play an error sound in case an error is logged.

This add-on provides an additional command (NVDA+control+alt+E) to toggle this setting. You can choose:

• "Only in test versions" (default) to make NVDA play error sounds only if the current NVDA version is a test version (alpha, beta or run from source).
• "Yes" to enable error sounds whatever your current NVDA version is.

For NVDA prior to 2021.3, this add-on provides the backport of this feature and the possibility to control it with the keyboard command. The checkbox in the Advanced settings panel is not backported however.

 

Object property explorer

This feature allows to report some properties of the current navigator object without opening the log viewer.

To list the properties of an object, move the navigator object to it and use the following commands:

• NVDA+Shift+LeftArrow or NVDA+Shift+RightArrow: select previous or next property and announce it for the navigator object.
• NVDA+LeftArrow : Announce the navigator object's currently selected property.

The list of the supported properties is the following: name, role, state, value, windowClassName, windowControlID, windowHandle, location, Python class, Python class mro.

This feature is an improvement of NVDA developer guide example 3

If you have installed Speech history review and copying add-on from Tyler Spivey and James Scholes, you may use it to copy and paste the announced property to review it. Review via copy/paste is especially useful for pythonClassMRO since it may be long.

 

Extended script description mode

When the Extended script description mode is active, the input help mode (NVDA+1) is modified as follows. If a script has no description, the script's name and class are reported. If a script has a description, its description is reported as usual. The gesture to activate or deactivate this feature is NVDA+control+alt+D.

Executing a gesture bound to a script without description in input help mode also create an entry for this script in the gesture management dialog. This entry is located in a dedicated category called "Scripts without description (modify at your own risk!)". This allow to easily add, delete or change the native NVDA gestures for these script. Be aware however that it is often intended that such script do not have any description to prevent the user to modify the associated gesture. Indeed, the gesture may be defined to match an application shortcut key. For example the script script_toggleItalic on NVDAObjects.window.winword.WordDocument is bound to control+I and this should not be modified since the gesture is passed to the application to actually execute the shortcut key.

 

Usage example

Control+shift+I also toggle italic in Word, even if it is not natively reported by NVDA. To have the control+shift+I result reported by NVDA as control+I, you should perform the following steps:

• Open a Word document.
• Enable the extended script description mode with NVDA+control+alt+D.
• Enter input help mode with NVDA+1.
• Press control+I to report the italic script and have it added in the gesture dialog.
• Exit input help mode with NVDA+1.
• Open the input gestures dialog.
• In the category "Scripts without description (modify at your own risk!)", select the command "toggleItalic on NVDAObjects.window.winword.WordDocument".
• Add the control+shift+I shortcut and validate.
• If you want, exit the extended script description mode with NVDA+control+alt+D.

Known bug: A script added for a specific class is visible even if gesture manager is opened in another context.

 

Log reading and analyzing commands

A log reader mode provides commands to ease log reading and analyzing. In the log viewer window the log reader is enabled by default, thus log reading commands are available immediately. In another text reading area such as an editor (e.g. Notepad++) or a webpage (e.g. GitHub issue), you need to press NVDA+control+alt+L to enable log reader mode and use its commands. When you are done with log reading and analyzing tasks, you can disable again NVDA+control+alt+L to disable the log reader mode.

The commands available in log reader mode are described hereafter.

 

Quick navigation commands

Single letter command similar to browse mode quick navigation keys allow to move to various type of log messages:

• m: any message
• e: ERROR
• i: IO
• d: DEBUG
• f: INFO
• g: DEBUGWARNING
• w: WARNING

Pressing the single letter moves to the next occurrence of this message. Combining the letter with the shift key moves to the previous occurrence of this message.

 

Opening a file in your editor

When looking at a traceback, you may want to open one of the source files to understand the cause and the context of the issue. Press C to open the source code file corresponding to the current line of the traceback.

For this feature to work, you need to have configured your favorite editor's command. If you are not running NVDA from source, the location of NVDA source code also should have been configured. For more details regarding the configuration, please see the paragraph NVDA Debug & Test Tools configuration.

 

Python console extension

In the console, you can call the following function to view the source code that defines the variable myVar:
openCodeFile(myVar)

For this feature to work, you need to have configured your favorite editor's command. If you are not running NVDA from source, the location of NVDA source code also should have been configured. For more details regarding the configuration, please see the paragraph NVDA Debug & Test Tools configuration.

The openCodeFile functions can be called on objects defined in NVDA's code or on objects defined by add-ons. It cannot be called on objects whose source code is not available such as python builtins.

Below are examples of call in NVDA's code:

• View the definition of the function speech.speech.speak:
  openCodeFile(speech.speech.speak)
• View the definition of the class TextInfo:
  openCodeFile(textInfos.TextInfo)
• View the definition of the method copyToClipboard of the class TextInfo:
  openCodeFile(textInfos.TextInfo.copyToClipboard)
• View the class definition of the focused object:
  openCodeFile(focus)
• Open the file api.py defining the module api:
  openCodeFile(api)

 

Log the stack trace of the speech function

Sometimes, you may want to see which part of the code is responsible for speaking something. For this, you can enable the stack trace logging of the speech function pressing NVDA+control+alt+S. Each time NVDA speaks, a corresponding stack trace will be logged in the log.

Note: You may modify the script's file directly to patch another function. See all instructions in the file for details on usage.

 

NVDA Debug & Test Tools configuration

The log reader commands and the python console extension feature may require a specific configuration. To use functions that allow to view source code in your editor, you should first configure your editor's command line. If NVDA's file need to be viewed and if you are not running from source, you also need to configure NVDA's source code path.

 

Editor's command line configuration

To use the 'open source code' command or the openCodeFile console command, you need first to configure the command that will be called to open the file in your favorite editor. For this, open the NVDA console (NVDA+control+Z) and type the following line and then Enter: config.conf['ndtt']['sourceFileOpener'] = r'"C:\path\to\my\editor\editor.exe" "{path}":{line}' You should of course modify this line according to the real name and location of your editor and the syntax used by it to open files. {path} will be replaced by the full path of the file to open and {line} by the line number where you want the cursor to be set. For Notepad++ for example the command to type in the console would be: config.conf['ndtt']['sourceFileOpener'] = r'"C:\Program Files\Notepad++\notepad++.exe" {path} -n{line}'

 

NVDA source code path configuration

When a file belonging to NVDA's core is listed in the traceback, the line is of the following form: File "config\profileUpgrader.pyc", line 30, in upgrade

If you are not running NVDA from source, you may specify an alternate location where the source file will be found, e.g. the place where you have cloned NVDA source files. In this case, you have to configure the path where you have NVDA source files located.

For this, open the NVDA console (NVDA+control+Z) and type the following line and then Enter: config.conf['ndtt']['nvdaSourcePath'] = r'C:\pathExample\GIT\nvda\source' Of course, replace the path of NVDA source with the correct one.

Be sure however that the version of your source file (e.g. GIT commit) is the same as the one of the running instance of NVDA.

 

Change log

 

Version 2.0

• New feature: Enhanced restart dialog to specify some extra options when restarting NVDA.
• New feature: extended description mode.
• Play error sound feature harmonized between pre and post 2021.3 versions of NVDA.
• New feature: Log reader commands are now available in the log viewer and also optionally in edit fields or webpages.
• New feature: In the Python console, an openCodeFile function is available to view the source code of an object.
• Some features are now disabled in secure mode for security reasons.
• The add-on's compatibility range has been extended (from 2019.2 to 2021.1).
• Releases are now performed with GitHub action instead of appVeyor.

 

Version 1.0

• Initial release.

 

•  

Hi Cyrille:

 

I"ll look at this add-on and, if needed, I"ll open issues on GitHub.

PS: for any reason, your message appears with a lot of hashtags, maybe due to autocompletion tools or something. I"ll try to edit the subject since it"s anoying to read them.

Cheers

Enviado desde mi iPhone

El 18 jun 2022, a las 0:12, Cyrille via groups.io <cyrille.bougot2@...> escribió:

 

Hello all

I am glad to share with you my add-on NVDA Dev & Test Toolbox.
The documentation is under my signature.
Direct download link: https://github.com/CyrilleB79/NVDA-Dev-Test-Toolbox/releases/download/V2.0/nvdaDevTestToolbox-2.0.nvda-addon

The add-on is not totally new but I had never advertised so much about it. If you find some issue or want to make feedback, do not hesitate, replying to this message or on the GitHub repo.
I plan to submit it for the community website if it interests people. As the name indicates, the audience target for this add-on are people developing or testing NVDA or its add-ons.
Let me know what you think.

Cheers,

Cyrille

NVDA Dev & Test Toolbox

• Author: Cyrille Bougot
• NVDA compatibility: 2019.2 and beyond
• Download stable version

This add-on gathers various features for NVDA debugging and testing.

 

Features

• An enhanced restart dialog to specify some extra options when restarting NVDA.
• A toggle script and a backport of NVDA's "Play a sound for logged errors" feature.
• An object property explorer.
• An extended script description mode: when enabled input help mode report information on scripts that have no description.
• Commands to help log reading and analyzing.
• In the Python console workspace, a function to open the source code of an object.
• A command to log the stack trace of the speech.speak function.

 

Enhanced restart dialog

The NVDA+shift+Q command opens a dialog to specify some extra options before restarting NVDA. The options that can be specified correspond to the command line options that can be used with nvda.exe, e.g. -c for config path, --disable-addons to disable add-ons, etc.

 

Play a sound for logged errors

The "Play a sound for logged errors" setting has been introduced in NVDA 2021.3 and allows to specify if NVDA will play an error sound in case an error is logged.

This add-on provides an additional command (NVDA+control+alt+E) to toggle this setting. You can choose:

• "Only in test versions" (default) to make NVDA play error sounds only if the current NVDA version is a test version (alpha, beta or run from source).
• "Yes" to enable error sounds whatever your current NVDA version is.

For NVDA prior to 2021.3, this add-on provides the backport of this feature and the possibility to control it with the keyboard command. The checkbox in the Advanced settings panel is not backported however.

 

Object property explorer

This feature allows to report some properties of the current navigator object without opening the log viewer.

To list the properties of an object, move the navigator object to it and use the following commands:

• NVDA+Shift+LeftArrow or NVDA+Shift+RightArrow: select previous or next property and announce it for the navigator object.
• NVDA+LeftArrow : Announce the navigator object's currently selected property.

The list of the supported properties is the following: name, role, state, value, windowClassName, windowControlID, windowHandle, location, Python class, Python class mro.

This feature is an improvement of NVDA developer guide example 3

If you have installed Speech history review and copying add-on from Tyler Spivey and James Scholes, you may use it to copy and paste the announced property to review it. Review via copy/paste is especially useful for pythonClassMRO since it may be long.

 

Extended script description mode

When the Extended script description mode is active, the input help mode (NVDA+1) is modified as follows. If a script has no description, the script's name and class are reported. If a script has a description, its description is reported as usual. The gesture to activate or deactivate this feature is NVDA+control+alt+D.

Executing a gesture bound to a script without description in input help mode also create an entry for this script in the gesture management dialog. This entry is located in a dedicated category called "Scripts without description (modify at your own risk!)". This allow to easily add, delete or change the native NVDA gestures for these script. Be aware however that it is often intended that such script do not have any description to prevent the user to modify the associated gesture. Indeed, the gesture may be defined to match an application shortcut key. For example the script script_toggleItalic on NVDAObjects.window.winword.WordDocument is bound to control+I and this should not be modified since the gesture is passed to the application to actually execute the shortcut key.

 

Usage example

Control+shift+I also toggle italic in Word, even if it is not natively reported by NVDA. To have the control+shift+I result reported by NVDA as control+I, you should perform the following steps:

• Open a Word document.
• Enable the extended script description mode with NVDA+control+alt+D.
• Enter input help mode with NVDA+1.
• Press control+I to report the italic script and have it added in the gesture dialog.
• Exit input help mode with NVDA+1.
• Open the input gestures dialog.
• In the category "Scripts without description (modify at your own risk!)", select the command "toggleItalic on NVDAObjects.window.winword.WordDocument".
• Add the control+shift+I shortcut and validate.
• If you want, exit the extended script description mode with NVDA+control+alt+D.

Known bug: A script added for a specific class is visible even if gesture manager is opened in another context.

 

Log reading and analyzing commands

A log reader mode provides commands to ease log reading and analyzing. In the log viewer window the log reader is enabled by default, thus log reading commands are available immediately. In another text reading area such as an editor (e.g. Notepad++) or a webpage (e.g. GitHub issue), you need to press NVDA+control+alt+L to enable log reader mode and use its commands. When you are done with log reading and analyzing tasks, you can disable again NVDA+control+alt+L to disable the log reader mode.

The commands available in log reader mode are described hereafter.

 

Quick navigation commands

Single letter command similar to browse mode quick navigation keys allow to move to various type of log messages:

• m: any message
• e: ERROR
• i: IO
• d: DEBUG
• f: INFO
• g: DEBUGWARNING
• w: WARNING

Pressing the single letter moves to the next occurrence of this message. Combining the letter with the shift key moves to the previous occurrence of this message.

 

Opening a file in your editor

When looking at a traceback, you may want to open one of the source files to understand the cause and the context of the issue. Press C to open the source code file corresponding to the current line of the traceback.

For this feature to work, you need to have configured your favorite editor's command. If you are not running NVDA from source, the location of NVDA source code also should have been configured. For more details regarding the configuration, please see the paragraph NVDA Debug & Test Tools configuration.

 

Python console extension

In the console, you can call the following function to view the source code that defines the variable myVar:
openCodeFile(myVar)

For this feature to work, you need to have configured your favorite editor's command. If you are not running NVDA from source, the location of NVDA source code also should have been configured. For more details regarding the configuration, please see the paragraph NVDA Debug & Test Tools configuration.

The openCodeFile functions can be called on objects defined in NVDA's code or on objects defined by add-ons. It cannot be called on objects whose source code is not available such as python builtins.

Below are examples of call in NVDA's code:

• View the definition of the function speech.speech.speak:
  openCodeFile(speech.speech.speak)
• View the definition of the class TextInfo:
  openCodeFile(textInfos.TextInfo)
• View the definition of the method copyToClipboard of the class TextInfo:
  openCodeFile(textInfos.TextInfo.copyToClipboard)
• View the class definition of the focused object:
  openCodeFile(focus)
• Open the file api.py defining the module api:
  openCodeFile(api)

 

Log the stack trace of the speech function

Sometimes, you may want to see which part of the code is responsible for speaking something. For this, you can enable the stack trace logging of the speech function pressing NVDA+control+alt+S. Each time NVDA speaks, a corresponding stack trace will be logged in the log.

Note: You may modify the script's file directly to patch another function. See all instructions in the file for details on usage.

 

NVDA Debug & Test Tools configuration

The log reader commands and the python console extension feature may require a specific configuration. To use functions that allow to view source code in your editor, you should first configure your editor's command line. If NVDA's file need to be viewed and if you are not running from source, you also need to configure NVDA's source code path.

 

Editor's command line configuration

To use the 'open source code' command or the openCodeFile console command, you need first to configure the command that will be called to open the file in your favorite editor. For this, open the NVDA console (NVDA+control+Z) and type the following line and then Enter: config.conf['ndtt']['sourceFileOpener'] = r'"C:\path\to\my\editor\editor.exe" "{path}":{line}' You should of course modify this line according to the real name and location of your editor and the syntax used by it to open files. {path} will be replaced by the full path of the file to open and {line} by the line number where you want the cursor to be set. For Notepad++ for example the command to type in the console would be: config.conf['ndtt']['sourceFileOpener'] = r'"C:\Program Files\Notepad++\notepad++.exe" {path} -n{line}'

 

NVDA source code path configuration

When a file belonging to NVDA's core is listed in the traceback, the line is of the following form: File "config\profileUpgrader.pyc", line 30, in upgrade

If you are not running NVDA from source, you may specify an alternate location where the source file will be found, e.g. the place where you have cloned NVDA source files. In this case, you have to configure the path where you have NVDA source files located.

For this, open the NVDA console (NVDA+control+Z) and type the following line and then Enter: config.conf['ndtt']['nvdaSourcePath'] = r'C:\pathExample\GIT\nvda\source' Of course, replace the path of NVDA source with the correct one.

Be sure however that the version of your source file (e.g. GIT commit) is the same as the one of the running instance of NVDA.

 

Change log

 

Version 2.0

• New feature: Enhanced restart dialog to specify some extra options when restarting NVDA.
• New feature: extended description mode.
• Play error sound feature harmonized between pre and post 2021.3 versions of NVDA.
• New feature: Log reader commands are now available in the log viewer and also optionally in edit fields or webpages.
• New feature: In the Python console, an openCodeFile function is available to view the source code of an object.
• Some features are now disabled in secure mode for security reasons.
• The add-on's compatibility range has been extended (from 2019.2 to 2021.1).
• Releases are now performed with GitHub action instead of appVeyor.

 

Version 1.0

• Initial release.

 

•