Web Access for NVDA

Web application modules support for modern or complex web sites.

Copyright (C) 2015-2018 Accessolutions (http://accessolutions.fr)

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

See the file COPYING.txt at the root of this distribution for more details.

Requirements

This is an add-on targeting the NVDA screen reader version 2016.2 or greater.

Additionally, the following software is required in order to build this add-on:

Virtual environment

The recommended way to setup a Python build environment is to use virtualenv.

It is especially true when using different versions and flavours of the Python interpreter or working on projects that might have conflicting dependencies.

In this section, we will assume your Python 2.7 32 bits interpreter is not in the PATH environment variable. In later sections, we will assume it either is or you activated (as we recommend) the dedicated virtual environment.

The following commands use our dev team installation paths, amend according to your needs.

The new nvda-addon virtual environment is now ready to build our addon.

Note that it can also be used by many IDEs, such as PyDev for Eclipse, as the interpreter for the project.

Build

This add-on is based upon the addonTemplate from the NVDA Add-ons Team and, as such, is built using SCons.

Depending on your environment, your SCons command might be either scons.py or scons.bat. As a convention, scons will be used within this document.

The following commands are to be run from the project root folder.

Generate Gettext POT translation file

scons pot

The resulting WebAccess.pot file will be created (or updated) in the project root folder.

Build the installation package

scons

The resulting WebAccess-<version>.nvda-addon file will be created (or updated) in the project root folder.

Cleaning

In order to ease in place execution during development, the manifest and documentation files generated by the build process are stored within the source tree, instead of a separate build folder.

To get rid of them:

scons -c

To also get rid of the generated Gettext POT translation file:

scons -c pot

Install

This project follows NVDA standards regarding installation of .nvda-addon files.

However, one might want to use a development version executed directly from the source tree.

A possible solution is to use file-system junction. Run the following command from the current user config addons directory:

mklink /J WebAccess <path to the addon folder in the source tree>

Note: Local administrator privileges are required.

In this configuration, run the following command from the same directory to remove the junction, uninstalling the development version:

rd WebAccess