From acd8973ab061340cf173cc35fd2f2bb48d3309aa Mon Sep 17 00:00:00 2001 From: joe-allen-89 <85872286+joe-allen-89@users.noreply.github.com> Date: Mon, 25 Apr 2022 10:07:08 +0100 Subject: [PATCH] Major version/framework bump for breaking changes. --- README.md | 24 ++++++++++++------------ bower.json | 2 +- package.json | 4 ++-- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3b9d1b6..fd2e916 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # adapt-contrib-bookmarking -**Bookmarking** is an *extension* bundled with the [Adapt framework](https://github.com/adaptlearning/adapt_framework). +**Bookmarking** is an *extension* bundled with the [Adapt framework](https://github.com/adaptlearning/adapt_framework). -The **Bookmarking** extension is responsible for maintaining a record of the learner's current location within the course so that when they quit and relaunch they may be given the option to be returned to that same location - hence the term 'bookmarking'. +The **Bookmarking** extension is responsible for maintaining a record of the learner's current location within the course so that when they quit and relaunch they may be given the option to be returned to that same location - hence the term 'bookmarking'. > Note that although 'bookmarking' is a feature of SCORM and the **Bookmarking** extension therefore requires the [Spoor extension](https://github.com/adaptlearning/adapt-contrib-spoor), it has nothing whatsoever to do with the storing and restoring of course progress; this is handled by the spoor extension completely independently of the bookmarking function and will take place whether the **Bookmarking** extension is installed/enabled or not. @@ -12,7 +12,7 @@ Upon returning to the course, a prompt inquires whether the learner would like t This prompt will not appear on first launch or if the user exits from the top-level menu. -[Visit the **Bookmarking** wiki](https://github.com/adaptlearning/adapt-contrib-bookmarking/wiki) for more information about its functionality and for explanations of key properties. +[Visit the **Bookmarking** wiki](https://github.com/adaptlearning/adapt-contrib-bookmarking/wiki) for more information about its functionality and for explanations of key properties. ## Installation @@ -34,14 +34,14 @@ With the [Adapt CLI](https://github.com/adaptlearning/adapt-cli) installed, run ``` (This second method will reinstall all plug-ins listed in *adapt.json*.) -* If **Bookmarking** 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). +* If **Bookmarking** 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).
Back to Top
## Settings Overview **Bookmarking** is configured with the attributes that follow. It is configured on two levels of the [content structure](https://github.com/adaptlearning/adapt_framework/wiki/Framework-in-five-minutes#content-structure): course (*course.json*) and contentObject (*contentObjects.json*). The attributes are so grouped below and are properly formatted as JSON in [*example.json*](https://github.com/adaptlearning/adapt-contrib-bookmarking/blob/master/example.json). -Visit the [**Bookmarking** wiki](https://github.com/adaptlearning/adapt-contrib-bookmarking/wiki) for more information about how they appear in the [authoring tool](https://github.com/adaptlearning/adapt_authoring/wiki). +Visit the [**Bookmarking** wiki](https://github.com/adaptlearning/adapt-contrib-bookmarking/wiki) for more information about how they appear in the [authoring tool](https://github.com/adaptlearning/adapt_authoring/wiki). ## Attributes @@ -92,14 +92,14 @@ Allows you to override the **\_level** setting defined in *course.json* with a s
Back to Top
## Limitations -**Bookmarking** only works if the [spoor plugin](https://github.com/adaptlearning/adapt-contrib-spoor) is enabled and the course is being launched from an LMS OR the xAPI plugin is enabled and the course is connected to an LRS. +**Bookmarking** only works if the [spoor plugin](https://github.com/adaptlearning/adapt-contrib-spoor) is enabled and the course is being launched from an LMS OR the xAPI plugin is enabled and the course is connected to an LRS. >**Note: Bookmarking** will work without an LMS if run via scorm_test_harness as explained in https://github.com/adaptlearning/adapt-contrib-spoor#client-local-storage--fake-lms--adapt-lms-behaviour-testing. However, this is intended only for development, not for production. ---------------------------- -**Version number:** 3.3.3 adapt learning logo -**Framework versions:** 5.8+ -**Author / maintainer:** Adapt Core Team with [contributors](https://github.com/adaptlearning/adapt-contrib-bookmarking/graphs/contributors) -**Accessibility support:** WAI AA -**RTL support:** Yes -**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera +**Version number:** 4.0.0 adapt learning logo +**Framework versions:** 5.19.1+ +**Author / maintainer:** Adapt Core Team with [contributors](https://github.com/adaptlearning/adapt-contrib-bookmarking/graphs/contributors) +**Accessibility support:** WAI AA +**RTL support:** Yes +**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera diff --git a/bower.json b/bower.json index 8647232..edb6e5f 100644 --- a/bower.json +++ b/bower.json @@ -1,6 +1,6 @@ { "name": "adapt-contrib-bookmarking", - "version": "3.3.3", + "version": "4.0.0", "framework": ">=5.19.1", "homepage": "https://github.com/adaptlearning/adapt-contrib-bookmarking", "bugs": "https://github.com/adaptlearning/adapt-contrib-bookmarking/issues", diff --git a/package.json b/package.json index ee72207..edb6e5f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "adapt-contrib-bookmarking", - "version": "3.3.3", - "framework": ">=5.8", + "version": "4.0.0", + "framework": ">=5.19.1", "homepage": "https://github.com/adaptlearning/adapt-contrib-bookmarking", "bugs": "https://github.com/adaptlearning/adapt-contrib-bookmarking/issues", "extension" : "bookmarking",