Skip to content

Commit 91ffb48

Browse files
davidacmdavidacm
committed
updated manifest to add compatibility with NVDA 2021.3.1
updated readme.
1 parent 2ed16d2 commit 91ffb48

File tree

7 files changed

+177
-6
lines changed

7 files changed

+177
-6
lines changed

‎.github/workflows/upload-on-tag.yaml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Upload on new tags
2+
3+
on:
4+
push:
5+
tags:
6+
'*'
7+
8+
jobs:
9+
buildAndUpload:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v2
14+
- name: Set up Python 3.8
15+
uses: actions/setup-python@v2
16+
with:
17+
python-version: 3.8
18+
- name: Install dependencies
19+
run: |
20+
pip install scons markdown
21+
sudo apt update
22+
sudo apt install gettext
23+
- name: Add add-on version
24+
run: |
25+
import re
26+
with open("buildVars.py", 'r+', encoding='utf-8') as f:
27+
text = f.read()
28+
version = "${{ github.ref }}".split("/")[-1]
29+
text = re.sub("\"addon_version\" : ,", "\"addon_version\" : \"%s\",", text) % version
30+
f.seek(0)
31+
f.write(text)
32+
f.truncate()
33+
shell: python
34+
- name: Build add-on
35+
run: scons
36+
- name: Calculate sha256
37+
run: sha256sum *.nvda-addon >> changelog.md
38+
- name: Release
39+
uses: softprops/action-gh-release@v1
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
with:
43+
files: |
44+
*.nvda-addon
45+
body_path: changelog.md
46+
prerelease: ${{ endsWith(github.ref, '-dev') }}

‎EnhancedPhoneticReading.code-workspace

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"folders": [
3+
{
4+
"path": "."
5+
}
6+
],
7+
"settings": {
8+
"editor.accessibilitySupport": "on",
9+
"python.linting.enabled": true,
10+
"python.linting.maxNumberOfProblems": 10000,
11+
"python.linting.flake8Args": [
12+
"--config=..\\..\\nvda\\tests\\lint\\flake8.ini",
13+
"--use-flake8-tabs=true"
14+
],
15+
"python.linting.flake8Enabled": true,
16+
"python.linting.pylintEnabled": false,
17+
"python.autoComplete.extraPaths": [
18+
"addon",
19+
"../../nvda/source",
20+
"../../nvda/include/comtypes",
21+
"../../nvda/include/configobj/src",
22+
"../../nvda/include/pyserial",
23+
"../../nvda/include/wxPython",
24+
"../../nvda/miscDeps/python"
25+
],
26+
"files.insertFinalNewline": true,
27+
"files.trimFinalNewlines": true,
28+
"editor.insertSpaces": false,
29+
"python.testing.unittestArgs": [
30+
"-v",
31+
"-s",
32+
"tests.unit",
33+
"-p",
34+
"test_*.py"
35+
],
36+
"python.testing.pytestEnabled": false,
37+
"python.testing.nosetestsEnabled": false,
38+
"python.testing.unittestEnabled": false,
39+
"python.analysis.extraPaths": [
40+
"addon",
41+
"../../nvda/source",
42+
"../../nvda/include/comtypes",
43+
"../../nvda/include/configobj/src",
44+
"../../nvda/include/pyserial",
45+
"../../nvda/include/wxPython",
46+
"../../nvda/miscDeps/python"
47+
]
48+
}
49+
50+
}

‎addonReadme.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Enhanced phonetic reading NVDA Add-on #
2+
This add-on add some features to phonetic reading like delayed character descriptions and instant character descriptions.
3+
4+
Copyright (C) 2022 David CM <dhf360@gmail.com>
5+
6+
This package is distributed under the terms of the GNU General Public License, version 2 or later.
7+
8+
## Download.
9+
The latest release is available to
10+
[download in this link](https://davidacm.github.io/getlatest/gh/davidacm/EnhancedPhoneticReading)
11+
12+
## Features.
13+
14+
* Delayed descriptions: Announce the character description for the last read character after n milliseconds when the character was read by character review commands, E.G. left and right arrow keys, left, current or right character review commands, ETC.
15+
* Instant character descriptions: Read the character description instead of the current character. This feature must be enabled or disabled manually and will be deactivated when NVDA is closed.
16+
17+
## Notes.
18+
19+
* When instant character descriptions are enabled, delayed descriptions won't be announced.
20+
* This add-on considers the auto language switching also. So if the last read character captured by this add-on was spoken in another language of your current default language, and auto language switching is on, the description will be read in the detected language.
21+
* For delayed descriptions only: all characters that don't have a description available for the specified language (locale characterDescriptions.dic) will be ignored. E.G. if you read the character "4" and the current default or detected language is Spanish, you won't get a delayed description because Spanish doesn't have a description for that symbol.
22+
* For developers: In general, any character sent with textInfos.UNIT_CHARACTER argument to speech.speakTextInfo will activate a delayed character description.
23+
24+
## Requirements
25+
You need NVDA 2018.3 or later.
26+
27+
## Installation
28+
Just install it as a NVDA add-on.
29+
30+
## Usage
31+
The add-on functionality will be enabled once you install it.
32+
To enable or disable it, go to NVDA settings and select "Enhanced phonetic reading". In that category you can set the following parameters:
33+
34+
* Enable delayed descriptions for characters.
35+
* Delay to announce character descriptions (in ms): the time the add-on waits to speak the description for the read character. You can't set it greater than 20000 ms.
36+
37+
## Scripts
38+
39+
* toggle instant character descriptions: Assigned to "nvda + control + numpad2" or "nvda+ control + enter" for laptop keyboards. This script enables or disables the instant character descriptions feature.
40+
* toggle delayed descriptions: no gestures assigned. This script lets you toggle the delayed descriptions status.
41+
42+
You can assign a command or gesture in speech category in the NVDA input gestures dialog.
43+
44+
## contributions, reports and donations
45+
46+
If you like my project or this software is useful for you in your daily life and you would like to contribute in some way, you can donate via the following methods:
47+
48+
* [PayPal.](https://paypal.me/davicm)
49+
* [Ko-fi.](https://ko-fi.com/davidacm)
50+
* [cryptocurrencies and other methods.](https://davidacm.github.io/donations/)
51+
52+
If you want to fix bugs, report problems or new features, you can contact me at: <dhf360@gmail.com>.
53+
54+
Or in the github repository of this project:
55+
[Enhanced phonetic reading on GitHub](https://github.com/davidacm/enhancedphoneticreading)
56+
57+
You can get the latest release of this add-on in that repository.

‎buildVars.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
announce the character description for the last read character after n milliseconds when the character was read by character review commands, E.G. left and right arrow keys, left, current or right character review commands, ETC.
2222
Read the character description instead of the current character. This feature must be enabled or disabled manually and will be deactivated when NVDA is closed."""),
2323
# version
24-
"addon_version" : "0.5a2",
24+
"addon_version" : ,
2525
# Author(s)
2626
"addon_author" : u"David CM <dhf360@gmail.com>",
2727
# URL for the add-on documentation support
@@ -31,7 +31,7 @@
3131
# Minimum NVDA version supported (e.g. "2018.3.0")
3232
"addon_minimumNVDAVersion" : "2018.3.0",
3333
# Last NVDA version supported/tested (e.g. "2018.4.0", ideally more recent than minimum version)
34-
"addon_lastTestedNVDAVersion" : "2019.3.0",
34+
"addon_lastTestedNVDAVersion" : "2021.3.1",
3535
# Add-on update channel (default is stable or None)
3636
"addon_updateChannel": "dev",
3737
}

‎changelog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Changes for 1.0 ##
2+
Updated manifest to add compatibility with NVDA 2021.3.1.
3+
Updated readme files.

‎readme.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Enhanced phonetic reading NVDA Add-on #
22
This add-on add some features to phonetic reading like delayed character descriptions and instant character descriptions.
33

4-
Copyright (C) 2019 David CM <dhf360@gmail.com>
4+
Copyright (C) 2022 David CM <dhf360@gmail.com>
55

66
This package is distributed under the terms of the GNU General Public License, version 2 or later.
77

@@ -39,4 +39,19 @@ This package is distributed under the terms of the GNU General Public License, v
3939
* toggle instant character descriptions: Assigned to "nvda + control + numpad2" or "nvda+ control + enter" for laptop keyboards. This script enables or disables the instant character descriptions feature.
4040
* toggle delayed descriptions: no gestures assigned. This script lets you toggle the delayed descriptions status.
4141

42-
You can assign a command or gesture in speech category in the NVDA input gestures dialog.
42+
You can assign a command or gesture in speech category in the NVDA input gestures dialog.
43+
44+
## contributions, reports and donations
45+
46+
If you like my project or this software is useful for you in your daily life and you would like to contribute in some way, you can donate via the following methods:
47+
48+
* [PayPal.](https://paypal.me/davicm)
49+
* [Ko-fi.](https://ko-fi.com/davidacm)
50+
* [cryptocurrencies and other methods.](https://davidacm.github.io/donations/)
51+
52+
If you want to fix bugs, report problems or new features, you can contact me at: <dhf360@gmail.com>.
53+
54+
Or in the github repository of this project:
55+
[Enhanced phonetic reading on GitHub](https://github.com/davidacm/enhancedphoneticreading)
56+
57+
You can get the latest release of this add-on in that repository.

‎sconstruct

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ def createAddonHelp(dir):
9797
cssPath = os.path.join(docsDir, "style.css")
9898
cssTarget = env.Command(cssPath, "style.css", Copy("$TARGET", "$SOURCE"))
9999
env.Depends(addon, cssTarget)
100-
if os.path.isfile("readme.md"):
100+
if os.path.isfile("addonReadme.md"):
101101
readmePath = os.path.join(docsDir, "en", "readme.md")
102-
readmeTarget = env.Command(readmePath, "readme.md", Copy("$TARGET", "$SOURCE"))
102+
readmeTarget = env.Command(readmePath, "addonReadme.md", Copy("$TARGET", "$SOURCE"))
103103
env.Depends(addon, readmeTarget)
104104

105105
def createAddonBundleFromPath(path, dest):

0 commit comments

Comments
 (0)