Skip to content

Commit

Permalink
New: Added ability to compile as SCORM 1.2 or SCORM 2004 (fixes adapt…
Browse files Browse the repository at this point in the history
  • Loading branch information
danielghost authored Dec 7, 2022
1 parent c8f42cf commit 497637a
Show file tree
Hide file tree
Showing 28 changed files with 1,904 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Spoor** is an *extension* bundled with the [Adapt framework](https://github.com/adaptlearning/adapt_framework).

This extension provides course tracking functionality (hence the name [spoor](https://en.wikipedia.org/wiki/Spoor_(animal))). Currently it only officially supports tracking to [SCORM](https://en.wikipedia.org/wiki/Sharable_Content_Object_Reference_Model) 1.2 [Learning Management Systems (LMS)](https://en.wikipedia.org/wiki/Learning_management_system), however, experienced users should be able to implement SCORM 2004 should this be needed as the underlying code is almost entirely version-agnostic (it's the packaging part you'll need to do yourself).
This extension provides course tracking functionality (hence the name [spoor](https://en.wikipedia.org/wiki/Spoor_(animal))) via [SCORM](https://en.wikipedia.org/wiki/Sharable_Content_Object_Reference_Model) standards for compliant [Learning Management Systems (LMS)](https://en.wikipedia.org/wiki/Learning_management_system). As default, only SCORM 1.2 or SCORM 2004 4th Edition files are included. See [_scormVersion](https://github.com/adaptlearning/adapt-contrib-spoor#_scormVersion) for details on how to configure this accordingly.

**Spoor** makes use of the excellent [pipwerks SCORM API Wrapper](https://github.com/pipwerks/scorm-api-wrapper/).

Expand Down Expand Up @@ -93,7 +93,7 @@ If set to `true` the status of the course is set to "incomplete" when the langug
The advanced settings objects contains the following settings. Note that you only need to include advanced settings if you want to change any of the following settings from their default values - and you only need to include those settings you want to change.

##### \_scormVersion (string):
This property defines what version of SCORM is targeted. Only SCORM 1.2 is officially supported by Adapt. SCORM 2004 should work, but the Adapt team don't include this version in testing. To enable SCORM 2004 support, change this value to `"2004"` and include the relevant SCORM 2004 packaging files (*imsmanifest.xml* and others - you can find examples over at [scorm.com](http://scorm.com/scorm-explained/technical-scorm/content-packaging/xml-schema-definition-files/)). The default is `"1.2"`.
This property defines what version of SCORM is targeted. Only SCORM 1.2 and SCORM 2004 4th Edition files are included. To use a different SCORM 2004 Edition, replace the [*scorm/2004*](https://github.com/adaptlearning/adapt-contrib-spoor/blob/master/scorm/2004) files accordingly - examples can be found at [scorm.com](http://scorm.com/scorm-explained/technical-scorm/content-packaging/xml-schema-definition-files/). Acceptable values are `"1.2"` or `"2004"`. The default is `"1.2"`.

##### \_showDebugWindow (boolean):
If set to `true`, a pop-up window will be shown on course launch that gives detailed information about what SCORM calls are being made. This can be very useful for debugging SCORM issues. Note that this pop-up window will appear automatically if the SCORM code encounters an error, even if this is set to `false`. You can also hold down the keys <kbd>d</kbd>+<kbd>e</kbd>+<kbd>v</kbd> to force the popup window to open. The default is `false`.
Expand Down
3 changes: 2 additions & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"semantic-release": "^19.0.3"
},
"scripts": {
"postversion": "cp package.json bower.json"
"postversion": "cp package.json bower.json",
"adaptpostcopy": "/scripts/postcopy.js"
},
"release": {
"plugins": [
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "adapt-contrib-spoor",
"version": "5.4.1",
"framework": ">=5.19.6",
"framework": ">=5.24",
"homepage": "https://github.com/adaptlearning/adapt-contrib-spoor",
"bugs": "https://github.com/adaptlearning/adapt-contrib-spoor/issues",
"extension": "spoor",
Expand All @@ -25,7 +25,8 @@
"semantic-release": "^19.0.3"
},
"scripts": {
"postversion": "cp package.json bower.json"
"postversion": "cp package.json bower.json",
"adaptpostcopy": "/scripts/postcopy.js"
},
"release": {
"plugins": [
Expand Down
13 changes: 13 additions & 0 deletions properties.schema
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,19 @@
"required": false,
"title": "Advanced Settings",
"properties": {
"_scormVersion": {
"type": "string",
"required": false,
"default": "1.2",
"title": "SCORM version",
"enum": ["1.2", "2004"],
"inputType": {
"type": "Select",
"options": ["1.2", "2004"]
},
"validators": [],
"help": "What SCORM standard to use - SCORM 1.2 or SCORM 2004 4th Edition."
},
"_showDebugWindow": {
"type": "boolean",
"required": false,
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 497637a

Please sign in to comment.