Skip to content

Latest commit

 

History

History
161 lines (128 loc) · 7.1 KB

README.md

File metadata and controls

161 lines (128 loc) · 7.1 KB
Raw

VoiceArt

Overview

Voice Art is a tool consisting of several components.

  • ItemRenderer is a module that transforms question items JSON content into HTML data. In addition, it performs simple grading in case the item is automatically gradable.
  • VoiceController is an extensible tool that allows working with tasks (including those generated by ItemRenderer) using voice commands. It provides speech recognition and user action emulation service. Also, the Voice Controller provides flexibility in user scenarios.

VoiceART is provided both on a commercial and free basis. The free version allows to you to use the key opportunities of the tool. The purchased version includes

  • all the functionality of the free version;
  • the server-based enhanced speech recognition;
  • customer support.

For the detailed information refer to the License section.

Installation

Install the voice-art module as dependency in your project via npm:

npm install git+https://github.com/competentum/voice-art.git

or download voice-art lib files from github

Usage

Connecting:

var VoiceArt = require('voice-art');//require module VoiceArt which contain the needed components
var ItemRenderer = VoiceArt.ItemRenderer;
var VoiceController = VoiceArt.VoiceController;
var VoiceCommander = VoiceArt.VoiceCommander;

or

<script src='{path to lib directory}/common.js'></script>
<script src='{path to lib directory}/item-renderer.js'></script>
<script src='{path to lib directory}/voice-controller.js'></script>

<script>
    //global var VoiceArt
    var ItemRenderer = VoiceArt.ItemRenderer;
    var VoiceController = VoiceArt.VoiceController;
    var VoiceCommander = VoiceArt.VoiceCommander;
</script>

Using ItemRenderer and VoiceController together

    var item = new ItemRenderer(containerElement, config); //init new task item according to the configuration
    var voiceController = new VoiceController(containerElement, settings); //init VoiceController which parse item html and create voice controller for it

ItemRenderer config json examples

The context property must be the same

Using VoiceController only (common scenario)

In this case, the default interaction scenario is used, with no non-standard behaviors, events, etc.

js:

    var voiceController = new VoiceController(container, {
      context: "common"
    });

Add to the task layout the following classes so that the Voice Controller can parse the field types successfully:

Class Element Description
vart-title element with item label or description A class containing the item description text.
vart-submit submit button element A class submitting item.
vart-field field wrapper element A class used as a field wrapper element which can contain an optional label or description.
vart-field-title field label element A class that contains field labels or descriptions.
vart-mc field wrapper element A class for Multiple Choice (MC) tasks processing (specifies the MC field type).
vart-mc-checkbox field wrapper element A class for Multiple Choice tasks processing It specifies the MC field checkbox subtype.
vart-mc-radio field wrapper element A class for Multiple Choice tasks processing. It specifies the MC field radio subtype.
vart-choice choice input element of mc A class for Multiple Choice tasks processing, it specifies the choice option in the Multiple Choice field type.
vart-dropdown field wrapper element A class for the Select tasks procesing that specifies the dropdown field type.
vart-essay field wrapper element A class for the essay tasks processing that specifies the corresponding field type.

For the 'mc' field type, add the "alternatives" attribute to each choice element as follows:

<div class="vart-choice" aria-label="Bill Clinton" alternatives="Bill, Clinton">
    <label>
        <input type="checkbox" value="a"/>Bill Clinton
    </label>
</div>

The specified words will be recognized as alternative answers.

So, the VC parses html according to these instructions and provides the voice control.

Using VoiceController only (custom scenario)

js:

    var voiceController = new VoiceController(container, {
      scenario: ScenarioClass
    });

Where 'ScenarioClass' is an es6 class (or constructor function) with custom scenario

Example

The following code sample illustrates working with Item Renderer and Voice Controller. It gets the JSON for the Multiple Choice task, renders HTML data and makes it possible for the user to answer the task with voice commands.

html head:

<script src='{path to lib directory}/jquery.js'></script>
<script src='{path to lib directory}/common.js'></script>
<script src='{path to lib directory}/item-renderer.js'></script>
<script src='{path to lib directory}/voice-controller.js'></script>

html body:

<div id="control_panel"></div>
<div id="item_container"></div>

js:

var ItemRenderer = VoiceArt.ItemRenderer;
var VoiceController = VoiceArt.VoiceController;
var VoiceCommander = VoiceArt.VoiceCommander;

var container = document.getElementById('item_container');
$.getJSON('samples/demo-pack/mc-checkbox.json', function(config){
    var item = new ItemRenderer(container, config);
    var voiceController = new VoiceController(container, {
      panelContainer: document.getElementById("control_panel"),
      controllerSettings: {mode: 1},
      maxNoSpeechErrors: 3,
      context: "cg"
    });
});

License

Competentum Commercial License

Competentum provides its VoiceART product under a dual license model designed to meet the development and distribution needs of both commercial and open source projects.

For Distributors of Commercial Applications:

Organizations that develop and/or distribute commercially licensed software with VoiceART software and do not wish to distribute the source code for the commercially licensed software under version 3 of the GNU General Public License (the "GPL") must enter into a commercial license agreement with Competentum.

For Open Source Projects and Other Developers of Open Source Applications:

For developers of applications under the GPL that want to combine and distribute those applications with VoiceART software, Competentum’s VoiceART open source software licensed under the GPL is the best option.

We encourage VoiceART users to learn about the license by reading the license and frequently asked questions provided by the Free Software Foundation.

VoiceART 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 VoiceART. If not, see http://www.gnu.org/licenses/.