Merge branch 'HFP-1174-overall-feedback'

css/questionset.css

@@ -225,30 +225,27 @@
   font-size: 1.25em;
 }
 
-.questionset-results .feedback-section .feedback-text {
-  font-weight: normal;
-  color: #777;
-}
-
 .questionset-results .buttons {
-  margin-bottom: 1.5em;
+  margin: 2em 0 1em 0;
 }
 
 .questionset-results .result-header,
-.questionset-results .result-text {
+.questionset-results .result-text,
+.questionset-results .feedback-section .feedback-text {
   color: #1a73d9;
   font-weight: bold;
 }
 
 .questionset-results .result-header {
   font-size: 2em;
-  margin-top: 1em;
+  margin: 1em 0.5em 0.5em 0.5em;
 }
 
-.questionset-results .result-text {
+.questionset-results .result-text,
+.questionset-results .feedback-section .feedback-text {
   font-size: 1.25em;
   line-height: 1.25em;
-  margin: 1em 1em 2.25em;
+  margin: 1em;
 }
 
 /* No margin for questions when no frame */

js/questionset.js

@@ -112,11 +112,13 @@ H5P.QuestionSet = function (options, contentId, contentData) {
       showResultPage: true,
       noResultMessage: 'Finished',
       message: 'Your result:',
-      successGreeting: 'Congratulations!',
+      oldFeedback: {
-      successComment: 'You have enough correct answers to pass the test.',
+        successGreeting: '',
-      failGreeting: 'Sorry!',
+        successComment: '',
-      failComment: "You don't have enough correct answers to pass this test.",
+        failGreeting: '',
-      scoreString: 'You got @score of @total points',
+        failComment: ''
+      },
+      overallFeedback: [],
       finishButtonText: 'Finish',
       solutionButtonText: 'Show solution',
       retryButtonText: 'Retry',
@@ -158,27 +160,27 @@ H5P.QuestionSet = function (options, contentId, contentData) {
   var randomizeQuestionOrdering = function (questions) {
 
     // Save the original order of the questions in a multidimensional array [[question0,0],[question1,1]...
-    var questionOrdering = questions.map(function(questionInstance, index) { return [questionInstance, index] });
+    var questionOrdering = questions.map(function (questionInstance, index) { return [questionInstance, index]; });
 
     // Shuffle the multidimensional array
     questionOrdering = H5P.shuffleArray(questionOrdering);
 
     // Retrieve question objects from the first index
-    var questions = [];
+    questions = [];
     for (var i = 0; i < questionOrdering.length; i++) {
       questions[i] = questionOrdering[i][0];
     }
 
     // Retrieve the new shuffled order from the second index
     var newOrder = [];
-    for (var i = 0; i< questionOrdering.length; i++) {
+    for (var j = 0; j < questionOrdering.length; j++) {
 
       // Use a previous order if it exists
       if (contentData.previousState && contentData.previousState.questionOrder) {
-        newOrder[i] = questionOrder[questionOrdering[i][1]];
+        newOrder[j] = questionOrder[questionOrdering[j][1]];
       }
       else {
-        newOrder[i] = questionOrdering[i][1];
+        newOrder[j] = questionOrdering[j][1];
       }
     }
 
@@ -312,8 +314,8 @@ H5P.QuestionSet = function (options, contentId, contentData) {
   var _updateButtons = function () {
     // Verify that current question is answered when backward nav is disabled
     if (params.disableBackwardsNavigation) {
-      if (questionInstances[currentQuestion].getAnswerGiven()
+      if (questionInstances[currentQuestion].getAnswerGiven() &&
-          && questionInstances.length-1 !== currentQuestion) {
+          questionInstances.length-1 !== currentQuestion) {
         questionInstances[currentQuestion].showButton('next');
       }
       else {
@@ -418,15 +420,19 @@ H5P.QuestionSet = function (options, contentId, contentData) {
 
     var currentQuestion = params.questions[currentQuestionIndex];
 
-    var hasAutoPlay = currentQuestion
+    var hasAutoPlay = currentQuestion &&
-      && currentQuestion.params.media
+        currentQuestion.params.media &&
-      && currentQuestion.params.media.params.playback.autoplay;
+        currentQuestion.params.media.params &&
+        currentQuestion.params.media.params.playback &&
+        currentQuestion.params.media.params.playback.autoplay;
 
-    if (hasAutoPlay) {
+    if (hasAutoPlay && typeof questionInstances[currentQuestionIndex].play === 'function') {
       questionInstances[currentQuestionIndex].play();
     }
   };
 
+
+
   /**
    * Show solutions for subcontent, and hide subcontent buttons.
    * Used for contracts with integrated content.
@@ -588,19 +594,19 @@ H5P.QuestionSet = function (options, contentId, contentData) {
       question.attach($('.question-container:eq(' + i + ')', $myDom));
 
       //Show buttons if necessary
-      if(questionInstances[questionInstances.length -1] === question
+      if (questionInstances[questionInstances.length -1] === question &&
-        && question.hasButton('finish')) {
+          question.hasButton('finish')) {
         question.showButton('finish');
       }
 
-      if(questionInstances[questionInstances.length -1] !== question
+      if (questionInstances[questionInstances.length -1] !== question &&
-        && question.hasButton('next')) {
+          question.hasButton('next')) {
         question.showButton('next');
       }
 
-      if(questionInstances[0] !== question
+      if (questionInstances[0] !== question &&
-        && question.hasButton('prev')
+          question.hasButton('prev') &&
-        && !params.disableBackwardsNavigation) {
+          !params.disableBackwardsNavigation) {
         question.showButton('prev');
       }
 
@@ -703,12 +709,9 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     // Get total score.
     var finals = self.getScore();
     var totals = self.getMaxScore();
-    var scoreString = params.endGame.scoreString.replace("@score", finals).replace("@total", totals);
+
+    var scoreString = H5P.Question.determineOverallFeedback(params.endGame.overallFeedback, finals / totals).replace('@score', finals).replace('@total', totals);
     var success = ((100 * finals / totals) >= params.passPercentage);
-    var eventData = {
-      score: scoreString,
-      passed: success
-    };
 
     /**
      * Makes our buttons behave like other buttons.
@@ -731,8 +734,8 @@ H5P.QuestionSet = function (options, contentId, contentData) {
 
       var eparams = {
         message: params.endGame.showResultPage ? params.endGame.message : params.endGame.noResultMessage,
-        comment: params.endGame.showResultPage ? (success ? params.endGame.successGreeting : params.endGame.failGreeting) : undefined,
+        comment: params.endGame.showResultPage ? (success ? params.endGame.oldFeedback.successGreeting : params.endGame.oldFeedback.failGreeting) : undefined,
-        resulttext: params.endGame.showResultPage ? (success ? params.endGame.successComment : params.endGame.failComment) : undefined,
+        resulttext: params.endGame.showResultPage ? (success ? params.endGame.oldFeedback.successComment : params.endGame.oldFeedback.failComment) : undefined,
         finishButtonText: params.endGame.finishButtonText,
         solutionButtonText: params.endGame.solutionButtonText,
         retryButtonText: params.endGame.retryButtonText
@@ -743,10 +746,6 @@ H5P.QuestionSet = function (options, contentId, contentData) {
       $myDom.append(endTemplate.render(eparams));
 
       if (params.endGame.showResultPage) {
-        // Add event handlers to summary buttons
-        hookUpButton('.qs-finishbutton', function () {
-          self.trigger('h5pQuestionSetFinished', eventData);
-        });
         hookUpButton('.qs-solutionbutton', function () {
           showSolutions();
           $myDom.children().hide().filter('.questionset').show();
@@ -1200,7 +1199,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     return {
       statement: xAPIEvent.data.statement,
       children: getXAPIDataFromChildren(this)
-    }
+    };
   };
 };
 

language/.en.json

@@ -141,30 +141,48 @@
           "description": "This heading will be displayed at the end of the quiz when the user has answered all questions."
         },
         {
-          "label": "Score display text",
+          "label": "Overall Feedback",
-          "description": "Text used to display Total user score. \"@score\" will be replaced by calculated score, \"@total\" will be replaced by maximum possible score. ",
+          "fields": [
-          "default": "You got @score of @total points"
+            {
+              "widgets": [],
+              "label": "Define custom feedback for any score range",
+              "description": "Example: 0-20% Bad score, 21-91% Average Score, 91-100% Great Score!",
+              "entity": "range",
+              "field": {
+                "fields": [
+                  {
+                    "label": "Score Range"
+                  },
+                  {},
+                  {
+                    "label": "Feedback for defined score range",
+                    "placeholder": "Fill in the feedback"
+                  }
+                ]
+              }
+            }
+          ]
         },
+        {
+          "label": "Old Feedback",
+          "fields": [
             {
               "label": "Quiz passed greeting",
-          "placeholder": "Congratulations!",
-          "default": "Congratulations!",
               "description": "This text will be displayed above the score if the user has successfully passed the quiz."
             },
             {
               "label": "Passed comment",
-          "default": "You did very well!",
               "description": "This comment will be displayed after the score if the user has successfully passed the quiz."
             },
             {
               "label": "Quiz failed title",
-          "default": "You did not pass this time.",
               "description": "This text will be displayed above the score if the user has failed the quiz."
             },
             {
               "label": "Failed comment",
-          "default": "Have another try!",
               "description": "This comment will be displayed after the score if the user has failed the quiz."
+            }
+          ]
         },
         {
           "label": "Solution button label",

library.json

@@ -3,7 +3,7 @@
   "description": "Put together a set of different questions that has to be solved. (Quiz)",
   "contentType": "question",
   "majorVersion": 1,
-  "minorVersion": 15,
+  "minorVersion": 13,
   "patchVersion": 0,
   "embedTypes": [
     "iframe"
@@ -14,7 +14,7 @@
   "author": "Joubel",
   "coreApi": {
     "majorVersion": 1,
-    "minorVersion": 6
+    "minorVersion": 14
   },
   "license": "MIT",
   "preloadedJs": [
@@ -50,6 +50,11 @@
     }
   ],
   "editorDependencies": [
+    {
+      "machineName": "H5PEditor.RangeList",
+      "majorVersion": 1,
+      "minorVersion": 0
+    },
     {
       "machineName": "H5PEditor.VerticalTabs",
       "majorVersion": 1,

semantics.json

@@ -276,7 +276,6 @@
         "label": "Feedback heading",
         "importance": "low",
         "default": "Your result:",
-        "optional": true,
         "description": "This heading will be displayed at the end of the quiz when the user has answered all questions.",
         "tags": [
           "strong",
@@ -284,21 +283,74 @@
         ]
       },
       {
-        "name": "scoreString",
+        "name": "overallFeedback",
-        "type": "text",
+        "type": "group",
-        "label": "Score display text",
+        "label": "Overall Feedback",
         "importance": "low",
-        "description": "Text used to display Total user score. \"@score\" will be replaced by calculated score, \"@total\" will be replaced by maximum possible score. ",
+        "fields": [
-        "default": "You got @score of @total points",
+          {
-        "optional": true
+            "name": "overallFeedback",
+            "type": "list",
+            "widgets": [
+              {
+                "name": "RangeList",
+                "label": "Default"
+              }
+            ],
+            "importance": "high",
+            "label": "Define custom feedback for any score range",
+            "description": "Example: 0-20% Bad score, 21-91% Average Score, 91-100% Great Score!",
+            "entity": "range",
+            "min": 1,
+            "defaultNum": 1,
+            "optional": true,
+            "field": {
+              "name": "overallFeedback",
+              "type": "group",
+              "importance": "low",
+              "fields": [
+                {
+                  "name": "from",
+                  "type": "number",
+                  "label": "Score Range",
+                  "min": 0,
+                  "max": 100,
+                  "default": 0,
+                  "unit": "%"
                 },
+                {
+                  "name": "to",
+                  "type": "number",
+                  "min": 0,
+                  "max": 100,
+                  "default": 100,
+                  "unit": "%"
+                },
+                {
+                  "name": "feedback",
+                  "type": "text",
+                  "label": "Feedback for defined score range",
+                  "importance": "low",
+                  "placeholder": "Fill in the feedback",
+                  "optional": true
+                }
+              ]
+            }
+          }
+        ]
+      },
+      {
+        "name": "oldFeedback",
+        "type": "group",
+        "label": "Old Feedback",
+        "importance": "low",
+        "deprecated": true,
+        "fields": [
           {
             "name": "successGreeting",
             "type": "text",
             "label": "Quiz passed greeting",
             "importance": "low",
-        "placeholder": "Congratulations!",
-        "default": "Congratulations!",
             "optional": true,
             "description": "This text will be displayed above the score if the user has successfully passed the quiz.",
             "tags": [
@@ -312,7 +364,6 @@
             "widget": "html",
             "label": "Passed comment",
             "importance": "low",
-        "default": "You did very well!",
             "optional": true,
             "description": "This comment will be displayed after the score if the user has successfully passed the quiz.",
             "tags": [
@@ -329,7 +380,6 @@
             "type": "text",
             "label": "Quiz failed title",
             "importance": "low",
-        "default": "You did not pass this time.",
             "optional": true,
             "description": "This text will be displayed above the score if the user has failed the quiz.",
             "tags": [
@@ -343,7 +393,6 @@
             "widget": "html",
             "label": "Failed comment",
             "importance": "low",
-        "default": "Have another try!",
             "optional": true,
             "description": "This comment will be displayed after the score if the user has failed the quiz.",
             "tags": [
@@ -354,6 +403,8 @@
               "a",
               "p"
             ]
+          }
+        ]
       },
       {
         "name": "solutionButtonText",

upgrades.js

@@ -52,6 +52,52 @@ H5PUpgrades['H5P.QuestionSet'] = (function ($) {
         // Remove old copyright dialog question label
         delete parameters.questionLabel;
 
+        finished(null, parameters);
+      },
+
+      /**
+       * Asynchronous content upgrade hook.
+       *
+       * Upgrade params to support overall feedback
+       *
+       * @param  {Object} parameters
+       * @param  {function} finished
+       */
+      13: function (parameters, finished) {
+
+        parameters.endGame = parameters.endGame || {};
+        parameters.endGame.overallFeedback = [];
+
+        if (parameters.endGame.scoreString) {
+          parameters.endGame.overallFeedback.push({
+            from: 0,
+            to: 100,
+            feedback: parameters.endGame.scoreString
+          });
+
+          delete parameters.endGame.scoreString;
+        }
+
+        // Group old feedback fields
+        if (parameters.endGame.successGreeting ||
+            parameters.endGame.successComment ||
+            parameters.endGame.failGreeting ||
+            parameters.endGame.failComment) {
+          parameters.endGame.oldFeedback = {};
+          if (parameters.endGame.successGreeting) {
+            parameters.endGame.oldFeedback.successGreeting = parameters.endGame.successGreeting;
+          }
+          if (parameters.endGame.successComment) {
+            parameters.endGame.oldFeedback.successComment = parameters.endGame.successComment;
+          }
+          if (parameters.endGame.failGreeting) {
+            parameters.endGame.oldFeedback.failGreeting = parameters.endGame.failGreeting;
+          }
+          if (parameters.endGame.failComment) {
+            parameters.endGame.oldFeedback.failComment = parameters.endGame.failComment;
+          }
+        }
+
         finished(null, parameters);
       }
     }