CHANGELOG.md

Unreleased

2.0.16 - 2017-01-20

Added

• functionality to add CSS classes to elements when they are in the viewport (#1100)
• screenHeight, orientation and aspectRatio properties to Adapt.device (#1331)
• option to disable automatic switching-on of accessibility on touch devices (#1370)
• ES5 shim for IE8 (#1346)
• getAvailableChildren to adaptModel (#1373)
• text-to-speech class to the html when _isTextProcessorEnabled is true (#1384)
• a data-adapt-id attribute to the HTML for pages, menus, articles, blocks + components (#1380)

Updated

• inview/jquery.onscreen library (#1302); full list of changes here.
• Bowser library to v1.5.0 (#1337)
• device.js to take advantage of new Bowser features (#1349)
• Handlebars compile helpers to allow them to take undefined and to allow specified context (#1347)

Fixed

• Hide the 'home' button in the navigation when at the top level of the course structure (#1315)
• XML substitutions are not replaced when building an xAPI course from the Adapt Authoring Tool (#1324)
• Locking not taking into account availability of children (#1373)

2.0.15 - 2016-11-14

Added

• preRemove and postRemove events

Fixed

• Inview not accounting for visibility and display none in change comparisons (#1299)
• Resources drawer appearing when changing language (#1295)
• Performance issue in authoring tool with Grunt copyMain task(#1312)

2.0.14 - 2016-10-18

Added

• support for multilanguage/course localisation.

2.0.13 - 2016-10-17

Added

• accessibility icon (part of #1182)

Changed

• removed underscore from accessibility toggle button labels (#1139)
• removed durationLabel from contentObjects.json as it hasn't been required since v2.0.3 of boxmenu (#1148)
• amends to JavaScript compilation to make it faster (#1228)

Fixed

• accessibility toggle button has no state (#1172)
• tracking ids grunt task only working in 'en' folders (#370)
• accessibility causing PLP scroll to jump down the page after scrolling to component (#1241)
• changing screen sizes in theme.json not persisted when running watch (#752)

2.0.12 - 2016-08-22

Added

• Accessibility-specific handlebars helpers (#1051)

Changed

• Various changes relating to ongoing work to allow Adapt to load and function even when no theme is installed (#953)

Fixed

• Issue with partially correct feedback not showing for adapt-contrib-matching component (#1187)
• Ongoing issue with correctly detecting screen width on iOS devices (#1096)

2.0.11 - 2016-07-26

Added

• global text support (#1049)
• abstract implementation of onSubmitted to allow question component plugins to extend this in the same way they can for onCannotSubmit (#1124)
• ability to completely hide the feedback button (#1073)

Changed

• standardised handlebars helper names (#1049)
• updated core libraries and npm modules to more recent versions (#1061)
• allow Drawer to be closed by Esc keypress when accessibility is not active (#938)
• different method of calculating screen width for better compatibility with iOS (#1096)
• various changes in preparation for the language picker functionality (#1120)
• various changes in preparation for moving _canShowMarking into core code (#1046)
• Allow user to be prevented from navigating to the menu using the browser's back button when the start controller is active (#1037 & #1152)

Fixed

• accessibility library occasionally throwing error 'Could not find the next focusable element' (#1015)
• using the navigateToHomeRoute function causing the page to jump to the top (#1079)
• tabindex being incorrectly applied to a11y-hideable elements (#1093)
• default values not being copied into course.json from schema files (#991)
• global properties in course.json out-of-date/inconsistent (#1136)
• bug with question marking introduced in v2.0.10 (#1114)

2.0.10 - 2016-05-09

Changed

• enhancement-967: questionView model code > questionModel (#981)
• change issues link from Jira to Github

Fixed

• issue-1047: downgrade less library (#1047)

2.0.9 - 2016-03-27

Added

• new 'locking' feature enables course authors to lock parts of the course until other parts have been completed (#905). Documentation for this feature can be found here. Note that locking needs to be supported in the menu plugin you are using - support for this has been added to adapt-contrib-boxmenu in v2.0.4
• new 'notify:cancelled' event added (#1009)

Changed

• various amends to the default content that bring it in line with changes to some of the core plugins, such as:
  • added _isEnabled property to _resources object in course.json
  • added _useClosedCaptions, _allowFullscreen and cc to the media component in components.json
  • added an example .vtt captions file to the video folder
  • removed instruction from the _globals object in course.json (#1031)

Fixed

• Leaving out the _classes property would cause a class of "undefined" to be added to the class list (#804)
• Intermittent error in the Grunt 'replace' tasks for authoring tool users (#1021)
• Temporary workaround for some LESS variables not being defined in the core theme (#1006)

2.0.8 - 2016-03-21

Added

• New documentation for config.json and course.json
• New 'start controller' functionality to allow for single page courses and start pages (#906)
• New property 'requireCompletionOf' to allow for author to specify how many components in a block need to be completed in order for the block to be completed (#910)
• Added support to for string substitution in XML files for the grunt dev, build and server-build tasks (#939)
• Added questionModel and component models, move model behaviour from views into relevant models(#925)

Changed

• Updates to index.html to remove invalid/unnecessary markup (#997)
• Better error message for when components.json references a component that isn't installed (#974)
• port number can now be passed as an optional parameter to the grunt server task (#917)
• remove requirejs coreJS and coreViews mappings (#929)

Fixed

• JQuery not always loading fast enough (#579)
• Component "left" and "right" layout getting ignored on mobile when JSON does not match order (#636 and #985)
• Issues with the inview library that would sometimes prevent components with 'inview' completion from being marked as completed (#956)
• function navigateToParent in router.js wasn't checking _canNavigate (#961)
• ordered list items weren't included in reset.less (#960)
• completion cascade not happening the right order (#927)

2.0.7 - 2016-02-08

Added

• New getParents helper function (returns an array where [0] = first parent and [x] = last parent)
• New getPath helper function (returns an array from [0] = current model and [x] = last parent)
• esc button now closes Notify popup (when a11y is off)

Changed

• Lots of improvements to the grunt build process:
  • All configs has been split into separate files per task (see grunt/config - uses load-grunt-config)
  • All Tasks have been split into separate files (see grunt/tasks)
  • Everything is now loaded asynchronously as and when it's needed (using jit-grunt)
  • New custom Javascript compiler:
    • No more bundle files (i.e. components.js/extensions.js/menu.js/theme.js)
    • Uses requirejs node module directly (no more grunt-contrib-requirejs)
  • New custom LESS compiler...with sourcemaps!
  • Removed a number of dependencies on grunt/npm plugins:
    • adapt-grunt-tracking-ids is now implemented directly in tracking-insert, tracking-remove and tracking-reset
    • assemble-less
    • bower
    • grunt-bower-requirejs
    • grunt-contrib-concat
    • grunt-contrib-less
    • grunt-contrib-requirejs
    • grunt-requirejs-bundle
    • lodash
    • matchdep
  • Added ability to include/exclude specific plugins (#723)
    • If excludes are specified, all plugins are included excluding those listed
    • If includes are specified, only those plugins listed will be included
    • If no includes/excludes are specified, all plugins are built, as before
  • Build folder cleaned before a new build to remove any lingering files
  • Added code style checking/enforcement using jshint/jscs
  • Added 'time-grunt' to show execution time for tasks
• Minor course .json amends

Fixed

• Accessibility:
  • Remove iOS select fix
  • Improved onFocusCapture to find next focusable component if cannot find any other.
  • Missing variable declararation, iOS
• imageReady: fixed background image checks
• We now defer any errors with bad plugins until after Adapt has loaded
• _isOptional setting no longer cascades to children (#923)

2.0.6 - 2015-12-02

Fixed

• Cached images causing slow loading in IE9 (ABU-1147)
• Issue with device:resize events not having accurate screen size info
• Navigation click events not working unless the item clicked is a button element

2.0.5 - 2015-11-30

Added

• Support for cross-domain requests (in supported browsers - for IE, this is only supported in 10+).
• Accessibility state now remembered across sessions (except on touch devices where it's always switched on)

Changed

• If there's only one item in the drawer, it's now opened by default
• More descriptive error thrown when attempting to render a missing component (#721)
• Various amends to the default course .json files provided with the framework
• Improvements to the 'inview' library

Fixed

• Lots of minor accessibility fixes
• Various router fixes

2.0.4 - 2015-10-30

Added

• Support for tracking user's responses to SCORM's cmi.interactions
• server-build: add the option to create sourcemaps (adaptlearning/adapt_authoring#811)

Changed

• Update LESS variables to new v2 style
• Performance improvements
• Allow partly correct feedback to be optional in question screens
• Property locking system improved

Fixed

• Various fixes for screenreader, keyboard & ios accessibility
• Ensure text labels are pulled through from 'globals' in course.json

2.0.3 - 2015-10-02

Fixed

• Popup tab index save/restore ABU-1075

2.0.2 - 2015-09-28

Added

• New button styles to base.less (#732, ABU-1069)
• New _spoor property _shouldStoreResponses to config.json (#701)

Changed

• Allow arrows keys to pass into input/select/textareas in a scroll-locked region (#738, ABU-1071)
• Update licence in package.json (#724, #727)
• Ensure loading animation shown before views removed (#719)
• Amend Notify to use .outerHeight for more accurate vertical alignment (#716)
• Amend answer to c-140 (#705)
• Updates to the a11y and onscreen libraries (#696, #697)

Removed

• Redundant labels from course.json

Fixed

• Ensure the remainingAttemptsText and remainingAttemptText get pulled through from _globals (#745, #746)
• Restored the navigateToHomeRoute function (#743, #744)
• Fix aimed at keeping content centralised on screen to give context to surroundings (#742)
• Notify focus bug (#740)
• Hyperlink to the community site in README.md
• Missing Page Level Progress, Menu, Visited labels into course.json
• Bug fix for no/touch so the focus guard functions (#710)
• IE8 responsiveness hotfix (#703)

2.0.1 - 2015-08-04

Fixed

• Added file .bowerrc back in; it is needed for the plugin registry system.

2.0.0 - 2015-08-03

This release is by far the biggest we’ve ever done; with the help of 17 contributors, the adapt_framework repository alone has seen over 420 commits, more than 6,400 additions and in excess of 13,400 deletions since we put out version 1.1.1.

As such, the changes are too numerous to mention here, but below are the highlights.

Added

• Adapt is now fully keyboard and screenreader accessible, and conforms to WAI level AA web content accessibility guidelines.
• Adapt now supports right-to-left languages such as Arabic and Hebrew.
• Page level progress now has the option of adding progress bars for each item.
• Support added for _isOptional, which allows developers to exclude elements from course progress calculations. This option also integrates with spoor for highly-customisable component tracking.
• Improvements to code syntax
• In addition to SCORM-compliant LMS support, spoor now also allows for offline tracking.
• Accordion items can now contain images.
• The narrative navigation buttons can be configured to show in the display text box.
• Text input now allows for more flexible answer combinations; in addition to the option-specific answers, there is now the ability to specify generic answers which can be submitted in any order.
• The media component now has an in-line (HTML) transcript.
• adapt-cli now supports tags, to allow for installing of specific versions of plugins.
• New components!
  • Assessment results
• New extensions!
  • Bookmarking

Changed

• Question component improvements:
  • Question interactions have been enhanced to allow for more control over how they are reset.
  • The ability to review previously viewed feedback.
  • The ability to display an overall mark (tick or cross) in addition to individual option marking.
  • The ability to toggle between ‘my answer’ and ‘model answer’
  • Randomisation of the order in which options are presented
• jQuery v2 is now used for IE9 and above.
• Complete rewrite of the inview library.
• Trickle has been completely overhauled with a number of bug-fixes and performance enhancements.
• All core libraries included with Adapt have been updated to their latest versions.
• The old assessment extension has been re-written, and now includes the following:
  • Multiple question banks offering configuration options such as:
    • Number of questions to be taken from a given bank.
    • Randomisation of presentation sequence.
  • Improved results feature providing configurable scoring bands, each with accompanying feedback text.
  • Scoring based on either a percentage or points based system.
• Complete restructure of the vanilla theme:
  • There is now a much more exhaustive list of self-descriptive variables to make it quicker and easier for those new to theming.
  • A theme-extras.less file containing more classes.
  • New attributes allow you to do more, for example:
    • _classes allows you to target specific menu items and page elements and apply styles.
    • _backgroundColor makes it easier to style individual block backgrounds.
  • Improvements to font management.

Removed

• All repositories have been given a good spring clean, removing a lot redundant code and files.

Fixed

• There are many performance improvements bundled in this release. The most significant being:
  • The removal of _lockedAttributes, which dealt a bit performance hit in older browsers.
  • More careful use of Underscore convenience methods, such as forEach().
• Many bug fixes in the adapt-cli’s install utility.

1.1.3 - 2015-06-23

Changed

• Slighty re-factored getChildren() to use comparator

Fixed

• 636: Corrects component _layout attribute issue.
• 628: Added missing ‘id’ attribute to index.html

1.1.2 - 2015-06-02

Added

• Added new navigation:homeButton event
• Grunt build process now allows for the use of a single menu/theme, rather than building all in src.
• Grunt process now allow for a custom output folder (for use with the authoring tool).

Changed

• Velocity.js updated.

Removed

• test folder removed.

Fixed

• Various JSON amends.
• Check for _canNavigate on navigateToHomeRoute.
• 573: bug in router navigateToParent() function when using nested pages.
• Added defensive programming to ensure findDescendants() and getChildren() fail silently.
• Bug with MCQ/GMCQ feedback to ensure correct type of feedback is returned.

1.1.1 - 2014-06-05

Fixed

• 380: Fixed location classes on the wrapper.
• 379: Fixes issue with questionView not displaying marking properly.
• 377: Fixes notFinal feedback not showing properly accross question components.
• 376: Fixes issue with feedback title not showing on incorrect and partly correct answers.
• 374: Fixes to model methods setting _isReady and _isComplete; now checks agains _isAvailable.

1.1.0 - 2014-05-28

Added

• Drawer: a slide out panel for plugins like resources and pageLevelProgress to place their data.
• Notify: a core notification system that allows plugins to display four types of notifications (popups, prompts, alerts and push).
• PopupManager: a simple manager that tracks the user’s scroll position when a popup is triggered.
• Handlebars partials templates have been added for buttons and components.
• Menu progress bars.
• New components!
  • Slider
  • Confidence slider
  • Linked confidence slider
• New extensions!
  • Resources
  • Page-level progress

Changed

• Updated all question components with the following:
  • Every core bundled question component now triggers a visual validation when a user interacts in the wrong way.
  • Feedback object in the JSON has been cleared up.
  • Triggers feedback event based upon lockedAttribute _canShowFeedback being true.
  • QuestionView now triggers an event even if _canShowFeedback is false.
  • QuestionModel now has _isQuestionType:true attached to the model to determine if the component is a question type.
• JSON notation standardised:
  • All JSON data now ‘_’ notation
  • Added instruction text and display title attributes.
• Navigation icons/buttons have been updated to work on smaller devices by increasing the hit area.
• The global Adapt object has been updated:
  • Adapt.device has been updated.
  • Adapt.location has been updated.
  • Adapt.scrollTo enables the page to scroll to an element.
  • Adapt.navigateToElement enables Adapt to route and then scroll to an element.
  • lockedAttributes are used to mediate between plugins setting attributes on models.
  • AdaptModel.getSiblings() now allows a boolean argument to pass back the model who called this method.
• Router has been rewritten:
  • Now allows plugins to use the core router without having to create their own.
  • The ‘back’ button now works similar to the browser back button.
• Performance enhancements:
  • Added velocity.js for animations.
  • Cleaned up model methods.
• Media component now has multiple completion criteria.
• Added component LESS classes to allow for better customisation.
• Tutor updates:
  • Now sits across the middle of the page ­ this is now easier to close.
  • Triggers popup manager and resizes based upon device width and height.
• The vanilla theme now includes an extended list of variables.
• Functional LESS has been moved from the theme into core.

Removed

• Mediator has been replaced with lockedAttributes.

1.0.0 - 2014-02-18

The initial version of the Adapt framework.

Added

• Everything!