Dragonfly

--------------------

Added
~~~~~
* Add additional tests to dragonfly's test suites.
* Add documentation for dragonfly's timer classes.
* Add new synchronous and process properties and error handling to
the RunCommand action.
* Add timer manager class for the text input and SAPI 5 engines.

Changed
~~~~~~~
* Change default engine class for SAPI 5 engine backend to
Sapi5InProcEngine.
* Change logging framework to use *~/.dragonfly.log* as the log
file to make logging work on Windows and on other operating
systems.
* Change the Natlink test suite to run different tests for
different DNS versions.
* Change the default test suite to the "text" engine's test suite
and add it to the CI build.
* Change typeables.py so that all symbols can be referred to by
their printable representation (thanks `wolfmanstout`_).
* Make several changes to the SAPI 5 engine backend so it passes
the relevant dragonfly tests.
* Update how _generate_typeables.py generates code used in
typeables.py.
* Update several documentation pages.
* Use a RecognitionObserver in dfly-loader-wsr.py for user feedback
when using Sapi5InProcEngine.

Fixed
~~~~~
* Add default implementation for the RunCommand.process_command
method so that most commands don't hang without an implementation.
* Fix bug where the Text action intermittently ignores the
hardware_apps override (thanks `wolfmanstout`_).
* Fix some encoding bugs with the text input engine.
* Fix various issues with dragonfly's tests and test framework.

Removed
~~~~~~~
* Remove old test files.

--------------------

Fixed
~~~~~
* Disable **backwards-incompatible** Unicode keyboard functionality by
default for the Text action. Restoring the old behaviour
requires deleting/modifying the `~/.dragonfly2-speech/settings.cfg`
file.

--------------------

Added
~~~~~
* Add configurable Windows Unicode keyboard support to the Text
action (thanks `Versatilus`_).
* Add Windows accessibility API support to Dragonfly (thanks
`wolfmanstout`_).
* Add a command-line interface for Dragonfly with a "test" command.
* Add multi-platform RunCommand action.
* Add text input engine backend.

Changed
~~~~~~~
* Change default paste key for the Paste action to Shift+insert.
* Change typeables.py to log errors for untypeable characters.
* Make **backwards-incompatible** change to the Text class where
it no longer respects modifier keys being held down by default.
* Move TestContext class from Pocket Sphinx engine tests into
test/infrastructure.py.
* Move command module classes from loader scripts into
dragonfly/loader.py.

Fixed
~~~~~
* Fix various Unicode and encoding issues (thanks `Versatilus`_).

-------------------

Changed
~~~~~~~
* Various changes to documentation.
* Make Arabic, Indonesian and Malaysian languages automatically load if
required.

Fixed
~~~~~
* Fix a bug with dragonfly's MagnitudeIntBuilder class specific to
Python 3.x.
* Replace all imports using 'dragonfly.all' with just 'dragonfly'.
* Fix a bug where mouse wheel scrolling fails with high repeat values
(thanks `wolfmanstout`_).
* Fix a few minor problems with the Pocket Sphinx engine.
* Fix error handling and logging when initialising the WSR/SAPI5
engine.

-------------------

Added
~~~~~
* Add default VAD decoder config options to Pocket Sphinx engine config
module.
* Add documentation page on dragonfly's supported languages.
* Add repository core.autorclf settings for consistent file line
endings.
* Add scrolling and extra button support for dragonfly's Mouse action
(thanks `Versatilus`_).

Changed
~~~~~~~
* Adjust pyperclip version requirements now that a bug is fixed.
* Change error types raised in a few Rule class methods.
* Change NatlinkEngine.speak() to turn on the mic after speech playback
for consistency between Dragon versions.
* Normalise all file line endings to Unix-style line feeds.

Fixed
~~~~~
* Make Read the Docs generate documentation from Python modules again.

-------------------

Added
~~~~~

* Add EngineBase.grammars property for retrieving loaded grammars.
* Add MappingRule.specs property to allow retrieval of specs after
initialisation.
* Add checks in Sphinx engine for using unknown words in grammars and
keyphrases.
* Add configurable speech and hypothesis recording to Sphinx engine for
model training.
* Add Sphinx engine documentation page.

Changed
~~~~~~~

* Change Sphinx engine module loader to use local engine config if it
exists.
* Change README to reference the new documentation page on the Sphinx
engine.
* Change documentation/conf.py to allow the docs to be built locally.
* Change package distribution name to *dragonfly2* in order to upload
releases to PyPI.org.
* Update README and documentation/installation.txt with instructions to
install via pip.
* Replace README.md with README.rst because PyPI doesn't easily support
markdown any more.

Fixed
~~~~~
* Fix a bug with CompoundRule.spec.
* Fix translation of RuleRef without explicit name in dragonfly2jsgf
(thanks `daanzu`_).
* Update virtual keyboard extended key support (thanks `Versatilus`_).
* Add missing methods for WSR and Sphinx engines in
test/element\_tester.
* Fix a few minor problems with the Sphinx engine.
* Fix bug where newly-constructed rules were not inactivated (thanks
`wolfmanstout`_).

Removed
~~~~~~~
* Remove pyjsgf submodule as it can be installed via pip now.
* Remove Sphinx engine's README now that there is a documentation page.
* Remove ez\_setup.py and stop using it in setup.py.