-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
39ff117
commit 1aa9f4b
Showing
3 changed files
with
112 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # NVDA Addon For the Multi-Track Editor Audacity # | ||
|
|
||
| Best compatible with version 2.2.2, restricted functionality for earlier versions (2.1.3+). | ||
|
|
||
| ## Features: | ||
|
|
||
| * Automatic announcement of time changes | ||
| * Audible feedback for setting start/end of selection during playback | ||
| * Shortcuts for manual Audio Position, Start, End, Center and Length controls | ||
| * Automatic Announcement of playback/recording states (Stopped, paused etc) | ||
| * Automatic announcement of commands after keypresses | ||
| * Audacity Input Help toggle for all default and custom shortcuts | ||
| * Shortcut for the system volume control | ||
| * Shortcuts for playback and recording meter levels | ||
| * Shortcut for Announcement of Selected, Muted and Soloed tracks | ||
| * Keys for tempo tapping | ||
| * Page up/down for faster navigation of multiple track projects | ||
| * Announcement of new values when moving sliders in effects | ||
| * Correct labels for effect controls | ||
| * Reordered "Recent Files", short name followed by full path | ||
| * Shortcuts for JAWS Guide and Addon Help | ||
|
|
||
| ---- | ||
|
|
||
| ## Full Help | ||
|
|
||
| ### Table of Default Keyboard Shortcuts | ||
| The shortcuts are mainly available in the Track View, exceptions are indicated | ||
| (Navigateable with table commands, such as Control+Alt+Arrows) | ||
|
|
||
| Shortcut | Description | Remarks | ||
| ----|----|---- | ||
| NVDA+H | Shows this Help | You can use browser navigation keys (e.g. h or t) and also NVDA+Control+F to search something. Press escape to close the window. | ||
| NVDA+G | Shows the famous JAWS Guide by David Bailes | Despite its name, the guide is essentially valid for all Screen Readers. Same keys useable as for the Help dialog. | ||
| NVDA+A | Reports the current Audio Position | The format is the same as the one in the Selection toolbar. Also true for other time commands. | ||
| NVDA+J | Reports the current Start Time | Always available, regardless of the visibility settings in the Selection Toolbar | ||
| NVDA+J (twice) | Reports the current Selection Center | | ||
| NVDA+K | Reports the current End Time | | ||
| NVDA+K (twice) | Reports the current Selection Length | | ||
| NVDA+E | Reports the Selected Tracks | | ||
| NVDA+E (twice) | Reports the Muted Tracks | | ||
| NVDA+E (three times) | Reports the Soloed Tracks | | ||
| F9 | Reports the Playback Meter Level| | ||
| F10 | Reports the Recording Meter Level| | ||
| Pause | Key for Tempo Tapping | Tap a steady rhythm for at least 5 beats. Wait a short time if you made a mistake. A new try is indicated by a higher beep. | ||
| NVDA+Pause | Reports the last Tempo Tapping result | Units are in bpm, beats per minute | ||
| NVDA+Pause | Pastes the last Tempo Tapping result into a numerical edit box | Usage is intended for e.g. the effect "Rhythm Track" in the Generate menu. | ||
| NVDA+Pause ( twice) | Reports the last Tempo Tapping result | Output is given as classical tempo description such as "Adagio or "Andante" | ||
| NVDA+X | Opens the System Volume Mixer | Here, you can balance out volume levels between NVDA, System sounds and Audacity. Use it also to mute e.g. Windows Notifications when you're about to record. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # NVDA Add-on Scons Template # | ||
|
|
||
| This package contains a basic template structure for NVDA add-on development, building, distribution and localization. | ||
| For details about NVDA add-on development please see the [NVDA Developer Guide](http://www.nvda-project.org/documentation/developerGuide.html). | ||
| The NVDA addon development/discussion list [is here](https://nvda-addons.groups.io/g/nvda-addons) | ||
|
|
||
| Copyright (C) 2012-2017 nvda addon team contributors. | ||
|
|
||
| This package is distributed under the terms of the GNU General Public License, version 2 or later. Please see the file COPYING.txt for further details. | ||
|
|
||
| ## Features | ||
|
|
||
| This template provides the following features you can use to help NVDA add-on development: | ||
|
|
||
| * Automatic add-on package creation, with naming and version loaded from a centralized build variables file (buildVars.py). | ||
| * Manifest file creation using a template (manifest.ini.tpl). Build variables are replaced on this template. | ||
| * Compilation of gettext mo files before distribution, when needed. | ||
| * To generate a gettext pot file, please run scons pot. A **addon-name.pot** file will be created with all gettext messages for your add-on. You need to check the buildVars.i18nSources variable to comply with your requirements. | ||
| * Automatic generation of manifest localization files directly from gettext po files. Please make sure buildVars.py is included in i18nFiles. | ||
| * Automatic generation of HTML documents from markdown (.md) files, to manage documentation in different languages. | ||
|
|
||
| ## Requirements | ||
|
|
||
| You need the following software to use this code for your NVDA add-ons development: | ||
|
|
||
| * a Python distribution (2.7 or greater is recommended). Check the [Python Website](http://www.python.org) for Windows Installers. | ||
| * Scons - [Website](http://www.scons.org/) - version 2.1.0 or greater. Install it using **easy_install** or grab an windows installer from the website. | ||
| * GNU Gettext tools, if you want to have localization support for your add-on - Recommended. Any Linux distro or cygwin have those installed. You can find windows builds [here](http://gnuwin32.sourceforge.net/downlinks/gettext.php). | ||
| * Markdown-2.0.1 or greater, if you want to convert documentation files to HTML documents. You can [Download Markdown-2.0.1 installer for Windows](https://pypi.python.org/pypi/Markdown/2.0.1) or get it using `easy_install markdown`. | ||
|
|
||
| ## Usage | ||
|
|
||
| ### To create a new NVDA add-on, taking advantage of this template: ### | ||
|
|
||
| 1. Create an empty folder to hold the files for your add-on. | ||
| 2. Create an **addon** folder inside this new folder. Inside **addon* folder, create needed folders for the add-on modules (e.g. appModules, synthDrivers, etc.). An add-on may have one or more module folders. | ||
| 3. Copy the **buildVars.py** file, the manifest.ini.tpl file, the manifest-translated.ini.tpl, **SCONSTRUCT**, site_scons, .gitignore and .gitattributes files to the created folder. | ||
| 4. In the **buildVars.py** file, change variable **addon_info** with your add-on's information (name, summary, description, version, author and url). | ||
| 5. Put your code in the usual folders for NVDA extension, under the **addon** folder. For instance: globalPlugins, synthDrivers, etc. | ||
| 6. Gettext translations must be placed into addon\locale\<lang>/LC_MESSAGES\nvda.po. | ||
|
|
||
| ### To manage documentation files for your addon: ### | ||
|
|
||
| 1. Copy the **readme.md** file for your add-on to the first created folder, where you copied **buildVars.py**. You can also copy **style.css** to improve the presentation of HTML documents. | ||
| 2. Documentation files (named **readme.md**) must be placed into addon\doc\<lang>/. | ||
|
|
||
| ### To package the add-on for distribution: ### | ||
|
|
||
| 1. Open a command line, change to the folder that has the **SCONSTRUCT** file (usually the root of your add-on development folder) and run the **scons** command. The created add-on, if there were no errors, is placed in the current directory. | ||
| 2. You can further customize variables in the **buildVars.py** file. | ||
|
|
||
| Note that this template only provides a basic add-on structure and build infrastructure. You may need to adapt it for your specific needs. | ||
|
|
||
| If you have any issues please use the NVDA addon list mentioned above. |