adapt-contrib-bookmarking

Bookmarking is an extension bundled with the 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'.

Note that although 'bookmarking' is a feature of SCORM and the Bookmarking extension therefore requires the Spoor extension, 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.

Upon returning to the course, a prompt inquires whether the learner would like to continue where they left off. If the learner selects "yes", the course navigates to the most recently visited structural element (page, block, or component), based on configuration. If the learner selects "no", the course remains at the top-level menu.

This prompt will not appear on first launch or if the user exits from the top-level menu.

Visit the Bookmarking wiki for more information about its functionality and for explanations of key properties.

Installation

As one of Adapt's core extensions, Bookmarking is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

• If Bookmarking has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line:
  adapt install adapt-contrib-bookmarking

  Alternatively, this component can also be installed by adding the following line of code to the adapt.json file:
  "adapt-contrib-bookmarking": "*"
  Then running the command:
  adapt install
  (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.

Back to Top

Settings Overview

Bookmarking is configured with the attributes that follow. It is configured on two levels of the content structure: course (course.json) and contentObject (contentObjects.json). The attributes are so grouped below and are properly formatted as JSON in example.json.

Visit the Bookmarking wiki for more information about how they appear in the authoring tool.

Attributes

course.json

The following attributes, set within course.json, configure the defaults for Bookmarking.

_bookmarking (object): The bookmarking object that contains values for _isEnabled, _level, _showPrompt, title, body, and _buttons.

_isEnabled (boolean): Controls whether the bookmarking extension is enabled or not.

_level (string): This value determines the type of view to which the learner is returned. Acceptable values are "page", "block" or "component". (The _id of the most recent view to trigger inview is used for routing.)

_showPrompt (boolean): Whether to show a prompt asking the user if they'd like to return to where they left off in their last visit or not. If set to false the user will be returned to where they left off automatically. The default is true.

title (string): Text that appears as the header of the prompt.

body (string): Text that inquires whether the learner would like to return to where they left off in their last visit.

_buttons (object): The buttons attribute group retains the labels to be used on the "yes" and "no" buttons. It contains values for yes and no.

yes (string): This text labels the button that returns the learner to the point of their last visit.

no (string): This text labels the button that cancels the jump.

Back to Top

contentObjects.json

The defaults set in course.json can be overridden for each contentObject of "_type": "page" by setting the following attributes in contentObjects.json.

_bookmarking (object): The Bookmarking object that contains values for _isEnabled and _level.

_isEnabled (boolean): Set to false to disable bookmarking for the specified content object.

_level (string): This value determines the type of view to which the learner is returned. Acceptable values are "page", "block" or "component". (The _id of the most recent view to trigger inview is used for routing.)

Back to Top

Limitations

Bookmarking only works if Spoor is enabled and the course is being presented in a learning management system (LMS).

Note: Bookmarking will work without an LMS if run via scorm_test_harness as explained in https:/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: 2.1.0 Framework versions: 2.0.18
Author / maintainer: Adapt Core Team with contributors
Accessibility support: WAI AA
RTL support: yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), Edge 12, IE 11, IE Mobile 11, Safari iOS 9+10, Safari OS X 9+10, Opera