Merged PR 305: v1.28.0 - support super/subscripts (#285)

- Support subscripts and superscripts through <sub> and <sup> tags, respectively - Put question_number before buzzes when outputting QBJ - Bump version to 1.28.0
alopezlago · Mar 11, 2024 · 458a25d · 458a25d
1 parent a2f4298
commit 458a25d
Show file tree

Hide file tree

Showing 7 changed files with 250 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "modaq",
-    "version": "1.27.0",
+    "version": "1.28.0",
     "description": "Quiz Bowl Reader using TypeScript, React, and MobX",
     "repository": {
         "type": "git",

diff --git a/src/components/FormattedText.tsx b/src/components/FormattedText.tsx
@@ -35,6 +35,14 @@ const FormattedSegment = observer(function FormattedSegment(props: IFormattedSeg
         element = <u>{element}</u>;
     }
 
+    if (props.segment.subscripted) {
+        element = <sub>{element}</sub>;
+    }
+
+    if (props.segment.superscripted) {
+        element = <sup>{element}</sup>;
+    }
+
     // Obsolete, but here for back-compat with YAPP versions before 0.2.4
     if (props.segment.required) {
         element = (

diff --git a/src/parser/FormattedTextParser.ts b/src/parser/FormattedTextParser.ts
@@ -10,19 +10,21 @@ export function parseFormattedText(text: string, pronunciationGuideMarkers?: [st
     let bolded = false;
     let emphasized = false;
     let underlined = false;
+    let subscripted = false;
+    let superscripted = false;
     let pronunciation = false;
     let startIndex = 0;
 
     // If we need to support older browswers, use RegExp, exec, and a while loop. See
     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/matchAll
     const matchIterator: IterableIterator<RegExpMatchArray> =
         pronunciationGuideMarkers == undefined
-            ? text.matchAll(/<\/?em>|<\/?req>|<\/?b>|<\/?u>/gi)
+            ? text.matchAll(/<\/?em>|<\/?req>|<\/?b>|<\/?u>|<\/?sub>|<\/?sup>/gi)
             : text.matchAll(
                   new RegExp(
-                      `<\\/?em>|<\\/?req>|<\\/?b>|<\\/?u>|${escapeRegExp(pronunciationGuideMarkers[0])}|${escapeRegExp(
-                          pronunciationGuideMarkers[1]
-                      )}`,
+                      `<\\/?em>|<\\/?req>|<\\/?b>|<\\/?u>|<\\/?sub>|<\\/?sup>|${escapeRegExp(
+                          pronunciationGuideMarkers[0]
+                      )}|${escapeRegExp(pronunciationGuideMarkers[1])}`,
                       "gi"
                   )
               );
@@ -42,6 +44,8 @@ export function parseFormattedText(text: string, pronunciationGuideMarkers?: [st
                 bolded,
                 emphasized,
                 underlined,
+                subscripted,
+                superscripted,
                 pronunciation,
             };
             result.push(formattedSlice);
@@ -77,6 +81,18 @@ export function parseFormattedText(text: string, pronunciationGuideMarkers?: [st
             case "</u>":
                 underlined = false;
                 break;
+            case "<sub>":
+                subscripted = true;
+                break;
+            case "</sub>":
+                subscripted = false;
+                break;
+            case "<sup>":
+                superscripted = true;
+                break;
+            case "</sup>":
+                superscripted = false;
+                break;
             default:
                 if (pronunciationGuideMarkers) {
                     if (tag === pronunciationGuideMarkers[0].toLowerCase()) {
@@ -106,6 +122,8 @@ export function parseFormattedText(text: string, pronunciationGuideMarkers?: [st
             bolded,
             emphasized,
             underlined,
+            subscripted,
+            superscripted,
             pronunciation,
         });
     }
@@ -150,6 +168,8 @@ export function splitFormattedTextIntoWords(
                 bolded: value.bolded,
                 emphasized: value.emphasized,
                 underlined: value.underlined,
+                subscripted: value.subscripted,
+                superscripted: value.superscripted,
                 pronunciation: value.pronunciation,
             });
             splitFormattedText.push(previousWord);
@@ -167,6 +187,8 @@ export function splitFormattedTextIntoWords(
                     bolded: value.bolded,
                     emphasized: value.emphasized,
                     underlined: value.underlined,
+                    subscripted: value.subscripted,
+                    superscripted: value.superscripted,
                     pronunciation: value.pronunciation,
                 };
                 splitFormattedText.push([formattedWord]);
@@ -180,6 +202,8 @@ export function splitFormattedTextIntoWords(
                 bolded: value.bolded,
                 emphasized: value.emphasized,
                 underlined: value.underlined,
+                subscripted: value.subscripted,
+                superscripted: value.superscripted,
                 pronunciation: value.pronunciation,
             });
         }

diff --git a/src/parser/IFormattedText.ts b/src/parser/IFormattedText.ts
@@ -5,4 +5,6 @@ export interface IFormattedText {
     pronunciation?: boolean;
     required?: boolean;
     underlined?: boolean;
+    subscripted?: boolean;
+    superscripted?: boolean;
 }
diff --git a/src/qbj/QBJ.ts b/src/qbj/QBJ.ts
@@ -288,8 +288,8 @@ export function toQBJ(game: GameState, packetName?: string, round?: number): IMa
 
         // We have to track tu/bonus question numbers
         const matchQuestion: IMatchQuestion = {
-            buzzes: [],
             question_number: i + 1,
+            buzzes: [],
             tossup_question: {
                 parts: 1,
                 type: "tossup",