|
1 | | -#adapt-contrib-tutor |
2 | | - |
3 | | - |
4 | | -An Adapt core contributed extension which is passed some feedback data and displays a basic overlay for question components. |
5 | | - |
| 1 | +# adapt-contrib-tutor |
| 2 | + |
| 3 | +**Tutor** is an *extension* bundled with the [Adapt framework] (https://github.com/adaptlearning/adapt_framework). |
| 4 | +It provides core [*question components*](https://github.com/adaptlearning/adapt_framework/wiki/Core-Plug-ins-in-the-Adapt-Learning-Framework#question-components) with the ability to display feedback in a modal overlay. Feedback is configured in the individual *question components*, not in **Tutor**. |
6 | 5 |
|
7 | 6 | ##Installation |
8 | 7 |
|
9 | | -First, be sure to install the [Adapt Command Line Interface](https://github.com/adaptlearning/adapt-cli), then from the command line run:- |
| 8 | +As one of Adapt's *[core extensions](https://github.com/adaptlearning/adapt_framework/wiki/Core-Plug-ins-in-the-Adapt-Learning-Framework#extensions),* **Tutor** is included with the [installation of the Adapt framework](https://github.com/adaptlearning/adapt_framework/wiki/Manual-installation-of-the-Adapt-framework#installation) and the [installation of the Adapt authoring tool](https://github.com/adaptlearning/adapt_authoring/wiki/Installing-Adapt-Origin). |
10 | 9 |
|
11 | | - adapt install adapt-contrib-tutor |
| 10 | +* If **Tutor** has been uninstalled from the Adapt framework, it may be reinstalled. |
| 11 | +With the [Adapt CLI](https://github.com/adaptlearning/adapt-cli) installed, run the following from the command line: |
| 12 | +`adapt install adapt-contrib-tutor` |
12 | 13 |
|
13 | | -This extension can also be installed by adding the extension to the adapt.json file before running `adapt install`: |
14 | | - |
15 | | - "adapt-contrib-tutor": "*" |
| 14 | + Alternatively, this component can also be installed by adding the following line of code to the *adapt.json* file: |
| 15 | + `"adapt-contrib-tutor": "*"` |
| 16 | + Then running the command: |
| 17 | + `adapt install` |
| 18 | + (This second method will reinstall all plug-ins listed in *adapt.json*.) |
16 | 19 |
|
17 | | -##Usage |
| 20 | +* If **Tutor** has been uninstalled from the Adapt authoring tool, it may be reinstalled using the [Plug-in Manager](https://github.com/adaptlearning/adapt_authoring/wiki/Plugin-Manager). |
18 | 21 |
|
19 | | -To be completed. |
| 22 | +##Settings |
20 | 23 |
|
21 | | -##Settings overview |
| 24 | +**Tutor** has no attributes to configure. |
22 | 25 |
|
23 | | -For example JSON format, see [example.json](example.json). A description of the core settings can be found at: [Core model attributes](https://github.com/adaptlearning/adapt_framework/wiki/Core-model-attributes) |
24 | | - |
25 | | -##Limitations |
| 26 | +## Limitations |
26 | 27 |
|
27 | | -To be completed. |
28 | | - |
29 | | -##Browser spec |
30 | | - |
31 | | -This component has been tested to the standard Adapt browser specification. |
| 28 | +No known limitations. |
| 29 | + |
| 30 | +---------------------------- |
| 31 | +**Version number:** 2.0 <a href="https://community.adaptlearning.org/ target="_blank"><img src="https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg" alt="adapt learning logo" align="right"></a> |
| 32 | +**Framework versions:** 2.0 |
| 33 | +**Author / maintainer:** Adapt Core Team with [contributors](https://github.com/adaptlearning/adapt-contrib-tutor/graphs/contributors) |
| 34 | +**Accessibility support:** WAI AA |
| 35 | +**RTL support:** yes |
| 36 | +**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), IE 11, IE10, IE9, IE8, IE Mobile 11, Safari for iPhone (iOS 7+8), Safari for iPad (iOS 7+8), Safari 8, Opera |
0 commit comments