Merge pull request #63 from livinNector/true-false-disambiguity

fix: refactored incorrectFeedback and correctFeedback to TrueFeedback…
fuhrmanator · Aug 16, 2024 · 7b088e2 · 7b088e2
2 parents af55489 + 9bd5925
commit 7b088e2
Show file tree

Hide file tree

Showing 28 changed files with 6,725 additions and 5,319 deletions.
diff --git a/GIFT.pegjs b/GIFT.pegjs
@@ -30,8 +30,8 @@
     switch(question.type) {
       case "TF":
         question.isTrue = answers.isTrue;
-        question.incorrectFeedback = answers.feedback[1];
-        question.correctFeedback = answers.feedback[2];
+        question.trueFeedback = answers.feedback[0];
+        question.falseFeedback = answers.feedback[1];
         break;
       case "MC":
       case "Numerical":
@@ -148,7 +148,7 @@ Match "match"
 ///////////
 TrueFalseAnswer "{T} or {F} or {TRUE} or {FALSE}"
   = isTrue:TrueOrFalseType _ 
-    feedback:(_ Feedback? Feedback?) _
+    feedback:(Feedback? Feedback?) _
     globalFeedback:GlobalFeedback?
   { return { type:"TF", isTrue: isTrue, feedback:feedback, globalFeedback:globalFeedback}; }
 
@@ -367,4 +367,4 @@ Space "(space)"
 EndOfLine "(end of line)"
   = '\r\n' / '\n' / '\r'
 EndOfFile 
-  = !. { return "EOF"; }
+  = !. { return "EOF"; }
diff --git a/docs/editor/giftPreview.js b/docs/editor/giftPreview.js
@@ -39,7 +39,11 @@ function giftPreviewHTML(qArray, theDiv) {
                 break;
             case "TF":
                 html += makeTitle("True/False", q.title);
-                html += pStemOpen + "<em class='d-print-none'>(" + (q.isTrue ? "True" : "False") + ") </em>" + applyFormat(q.stem) + " (✓ ✘)" + pStemClose;
+                html += pStemOpen + "<em class='d-print-none'>(" + 
+                    (q.isTrue ? "True" : "False") + ") " + 
+                    (q.trueFeedback ? " True feedback: " + applyFormat(q.trueFeedback, false) + "</div>" : "") +
+                    (q.falseFeedback ? " False feedback: " + applyFormat(q.falseFeedback, false) + "</div>" : "") +
+                    "</em>" + pStemOpen + applyFormat(q.stem) + " (✓ ✘)" + pStemClose;
                 html += formatFeedback(q.globalFeedback) + "</div>";
                 theDiv.append(html); html = "";
                 break;

diff --git a/docs/editor/lib/GIFT.pegjs b/docs/editor/lib/GIFT.pegjs
@@ -30,8 +30,8 @@
     switch(question.type) {
       case "TF":
         question.isTrue = answers.isTrue;
-        question.incorrectFeedback = answers.feedback[1];
-        question.correctFeedback = answers.feedback[2];
+        question.trueFeedback = answers.feedback[0];
+        question.falseFeedback = answers.feedback[1];
         break;
       case "MC":
       case "Numerical":
@@ -70,6 +70,20 @@
   function resetLastQuestionTextFormat() {
     format = defaultFormat;
   }
+  function formattedText(format, txt) {
+    let inferredFormat = (format !== null ? format : getLastQuestionTextFormat());
+    let joinedText = txt.join('')
+      .replace(/\r\n/g, '\n')  // replace Windows newlines with Unix newlines
+      .trim();
+    return {
+      format:(inferredFormat), 
+      text:(
+          ((inferredFormat == "html") || (inferredFormat == "markdown")) ? 
+            // keep whitespace and newlines for html and markdown
+            escapedCharacterDecode(joinedText) :
+            escapedCharacterDecode(removeNewLinesDuplicateSpaces(joinedText))
+          )}
+  }
 }
 
 GIFTQuestions
@@ -134,7 +148,7 @@ Match "match"
 ///////////
 TrueFalseAnswer "{T} or {F} or {TRUE} or {FALSE}"
   = isTrue:TrueOrFalseType _ 
-    feedback:(_ Feedback? Feedback?) _
+    feedback:(Feedback? Feedback?) _
     globalFeedback:GlobalFeedback?
   { return { type:"TF", isTrue: isTrue, feedback:feedback, globalFeedback:globalFeedback}; }
 
@@ -286,22 +300,10 @@ ControlChar
   = '=' / '~' / "#" / '{' / '}' / '\\' / ':'
 
 MatchRichText "(formatted text excluding '->')"
-  = format:Format? _ txt:MatchTextChar+ { return {
-      format:(format!==null ? format : getLastQuestionTextFormat()), 
-      text:(
-          (format !== "html" && format !== "markdown") ? 
-            escapedCharacterDecode(removeNewLinesDuplicateSpaces(txt.join('').trim())) :
-            escapedCharacterDecode(txt.join('')).replace(/\r\n/g,'\n').trim()
-          )}}  // avoid failing tests because of Windows line breaks 
+  = format:Format? _ txt:MatchTextChar+ { return formattedText(format, txt) } 
 
 RichText "(formatted text)"
-  = format:Format? _ txt:TextChar+ { return {
-      format:(format!==null ? format : getLastQuestionTextFormat()), 
-      text:(
-          (format !== "html" && format !== "markdown") ? 
-            escapedCharacterDecode(removeNewLinesDuplicateSpaces(txt.join('').trim())) :
-            escapedCharacterDecode(txt.join('')).replace(/\r\n/g,'\n').trim() // avoid failing tests because of Windows line breaks
-          )}} 
+  = format:Format? _ txt:TextChar+ { return formattedText(format, txt) } 
 
 PlainText "(unformatted text)"
   = txt:TextChar+ { return removeNewLinesDuplicateSpaces(txt.join('').trim())} 
@@ -365,4 +367,4 @@ Space "(space)"
 EndOfLine "(end of line)"
   = '\r\n' / '\n' / '\r'
 EndOfFile 
-  = !. { return "EOF"; }
+  = !. { return "EOF"; }
diff --git a/index.d.ts b/index.d.ts
@@ -151,8 +151,8 @@ export interface Essay extends Question {
 export interface TrueFalse extends Question {
   type: Extract<QuestionType, "TF">;
   isTrue: boolean;
-  incorrectFeedback: TextFormat | null;
-  correctFeedback: TextFormat | null;
+  trueFeedback: TextFormat | null;
+  falseFeedback: TextFormat | null;
 }
 
 export interface Matching extends Question {