Speech-Rule-Engine/speech-rule-engine v3.0.0

Version 3

on GitHub

This is the next major SRE release. It contains a number of new features and changes.
Possible breaking changes over 2.X are indicated in bold.

Nemeth Braille Implementation

• A full implementation for linearized Nemeth Braille translation
• Includes full support for math alphabets on Unicode Plane 1.
• This was sponsored by the Big Ten Academic Alliance

Multiple Modalities

• SRE's constraint system and indexing structure now support different modalities
• Most important modalities are Speech and Braille, others include Prefixes and Summary speech
• Engine option modality, command line option --modality or -b

Unicode Characters

• JSON mappings for Unicode characters are now combined into single file. One per locale!
• Selective loading of mappings, only when necessary. This means:
  • Locale en is loaded by default.
  • All other locales are only loaded when the engine locale option is reconfigured and if they have not yet been loaded.
  • In asynchronous operation (i.e., modes async or http) one has to wait for the engine to be ready (either with engineReady API function or sre.Engine.isReady() method) not just once on load, but every time the engine is reconfigured with setupEngine.
• Automatic generation of speech rules for all alphabets (Latin and Greek) and digit sets, including those on Unicode Plane 1.
• Major cleanup of English character mappings.

Speech Rules

• Deprecates all non-semantic speech rules sets.
• Improved message handing in speech rule sets for easier localisation.
• Clean up of ChromeVox speech rules; there are now only two styles: default which corresponds to the old short style and alternative. The old default, which was very verbose, has been dropped.

Build System

• Support for the new unicode single file structure. They need to be cleaned (make clean) to be automatically rebuilt when changes to the mappings are made.
• Uses latest versions of development libraries.

Tests

• Speech rule tests are now grouped by locale.
• Tests can be called separately by providing FILE or LOCALE parameter to make.

Others

• Exposure of navigation structure is now possible in enriched MathML.
• A number of bug fixes.