...

This document describes the problem statement and design for enabling the FTB in the (New) QuestionSet Editor/Player. 

JIRA Issue:

Background 

As we are deprecating the ECML Question creation inside the Interactive content editor. So inQuiry would need to have a suitable substitute for all its used capabilities in the (New) Question set editor.

...

1. There should be at least one blank 

2. Blanks can be created by using square brackets [[ ]] to indicate words to be made blank in a sentence 

3. Use square brackets [[ ]] to indicate blanks in the sentence. The words between [[ ]] will appear as blanks to students. 

   1. Example: 'The tree is [[tall]] and [[strong]].' The question will be created as: 'The tree is _______ and _______.' The correct answers will be 'tall' and 'strong'. 

4. Multiple blanks are supported 

5. Keyboard type: 

   1. System (Android / OS) 

   2. English (A-Z, not QWERTY) 

   3. Numbers only 

   4. 26 keys configurable 

6. Partial scoring 

7. Unordered evaluation 

8. Add Image and Audio to Question or Option 

9. Add Math & Scientific Text (Formulae & Equation) to Question or Option 

Problem Statement 

Currently, the QuestionSet editor does not support FTB Question creation.  

How can inQuiry enable the same capabilities in the new QuestionSet Editor with the same features supported by the existing Interactive editor? 

...

Design

In this solutionDesign, inQuiry will use the same code and functionality used in not be going to propose a new solution for enabling the FTB question. It will follow the same structure that is used by the interactive editor. The inquiry will build a new CKEditor 5 plugin that helps users to create

Creation workflow:

• For creating the question, inQuiry will use the same question component used for other question types.

• The creator can create the blanks using square brackets [[ ]] to indicate words

...

1. A button will be present in the toolbar similar to other buttons like Bold, Heading, etc... 

2. The user will be able to add blanks as below: 

   1. Using the button available in the toolbar. 

   2. By typing manually in the textarea. 

   3. Select the words first then click on the button available in the toolbar. 

3. The button will act as a toggle so by clicking on the button again, blanks can be removed and selected words will be converted into normal text. 

...

• to be made blank in a sentence.

  • The words between [[ ]] will appear as blanks in a player. 
    Example: 'The tree is [[tall]] and [[strong]].'
    The question will be created as: 'The tree is _______ and _______.'
    The correct answers will be tall and strong. 

• Answers will be extracted from the question using the regular expression (Ex. /(?:^|)\[\[(.*?(?:\]\]|$)/g )

  • We will refer to the existing code to extract the answers from the questions. Here’s the

...

• • link: 

...

• • https://github.com/

...

• • Sunbird-

...

• • Knowlg/sunbird-content-plugins/blob/

...

• • c7c385c7c3848f4fdeabd4f889a46675ef608cf3/org.ekstep.questionunit.ftb-1.1/editor/controllers/ftb-controller.

...

Keyboards: 

As of now, the following keyboard types are supported by the old editor: 

• Device  

• English 

• Custom   

This custom keyboard is written in pure javascript as a plugin embedded in the interactive editor loads based on needs and does not use any third-party library. So inQuiry will check the feasibility of this plugin and try to integrate it as is it. 

Here are the diff types of the sample configuration for each type:

1. Device -

   Code Block
   "keyboardConfig":{"keyboardType":"Device","customKeys":""}

2. English -

   Code Block
   "keyboardConfig":{"keyboardType":"English","customKeys":""}

3. Custom -

   Code Block
   "keyboardConfig":{"keyboardType":"Custom","customKeys":"h,v,t,m,n"}

We will store this configuration as part of the question metadata as this is an additional configuration given to the editor. This property has to be updated in the question schema file as below:

"keyboardConfig": {
      "type": "object",
      "items": {
        "type": "string",
        "enum": [
          "Device",
          "English",
          "Custom"
        ],
        "default": "Device"
      }
}

Media: Image + Audio 

All the images will be stored the way we are storing the images for the others type. 

The audio workflow will be not enabled in the new FTB workflow as the new question set editor does not have any audio feature in the asset browser. 

Here is the existing media sample:

...

• • js#L124

• The current QuestionSet editor has the capability to add the image and Math & Scientific Text. So We will use the same question component for the FTB question.

• All media images will be stored the way we are storing the images for the others question type. For example:

  Code Block

  // HTML <figure class="image"> <img src="/assets/public/content/assets/do_2136875639892623361238/download-1.jpg" alt="download (1)" data-asset-variable="do_2136875639892623361238"> </figure> <p>Who is this ?</p>   // JSON BODY "media": [{  "id": "do_2136875639892623361238",  "type": "image",  "src": "/assets/public/content/assets/do_2136875639892623361238/download-1.jpg",  "baseUrl": "https://dev.inquiry.sunbird.org"  }]

  (Note: The audio workflow will be not enabled in the new FTB workflow as the new question set editor does not have any audio feature support)

Consumption workflow:

When rendering the question on the player, consider the following:

• The QuML Player will read the question properties and replace all blanks with a <input> tag as per the QuML spec format. Here’s a sample example:

  Code Block
  The tree is <input type="text" data-text-interaction data-response-variable="response1"/> and <input type="text" data-text-interaction data-response-variable="response2" />

• Ignoring of white-space and case sensitive will be considered by default at the player level.

The below points to be considered during the evaluation:

1. All user answers must be converted to lowercase and compared against each of the answer variations after converting them also to lowercase.

2. Consider removing white spaces from the user answer and the expected answer variations (trim and also remove embedded white spaces)

Partial scoring

A Scoring Logic can have the following values:

...

The default value of Scoring Logic will be PARTIAL

Unordered evaluation

An Unordered evaluation Logic can have the following values:

• TRUE

  • Answers entered in an unordered sequence will be considered correct answers.

• FALSE

  • Answers entered in an unordered sequence will be not considered correct answers.

Unordered evaluation

An Unordered evaluation Logic can have the following values:

• TRUE

  • Answers entered in an unordered sequence will be considered correct answers.

• FALSE

  • Answers entered in an unordered sequence will be not considered correct answers.

FTB Data Model

Here’s the new schema structure for the FTB which is as per QuML compliance. 

...

The default value of Unordered evaluation will be FALSE

FTB Data Model

Here’s the new schema structure for the FTB which is as per QuML compliance. 

{
  "editorState": {
    "options": [{
        "answer": true,
        "value": {
          "body": "New Delhi",
          "value": 0
        }
      },
      {
        "answer": true,
        "value": {
          "body": "New York",
          "value": 1
        }
    }],
    "question": "<figure class="image"><img src="/assets/public/content/assets/do_2136875567564144641233/download.jpg" alt="download" data-asset-variable="do_2136875567564144641233"></figure><figure class="image"><img src="/assets/public/content/assets/do_2136875567564144641233/download.jpg" alt="download" data-asset-variable="do_2136875567564144641233"></figure>
        ]<p>capital of india     },
      "mapping": [
        {
       is [[New Delhi]]. and capital of USA is [[New York]]</p>"
  },
  "responsebody": 0,
          "outcomes": {"<figure class="image"><img src="/assets/public/content/assets/do_2136875567564144641233/download.jpg" alt="download" data-asset-variable="do_2136875567564144641233"></figure>
        <p>capital of india is  "score": 0.5
          }
        },
        {
   [[New Delhi]]. and capital of USA is [[New York]]</p>",
  "interactions": {
    "response1": {
      "type": "text",
      "responseoptions": 1,[{
          "outcomeslabel": {
 "New Delhi",
          "scorevalue": 0.5
 0
        },
        }{
      ]     }
"label": "New York",
 },   "outcomeDeclaration": {     "maxScorevalue": 1
  },   "media": [],  }
"body": "<p>capital of india is [[New Delhi]]. and
capital of USA is [[New York]]</p>" },
    "editorStatevalidation": {
      "optionsrequired": "Yes"
[    }
  {},
  "responseDeclaration": {
    "answerresponse1": true,{
        "valuecardinality": {
   "multiple",
      "bodytype": "New Delhistring",
 
        "valuecorrectResponse": 0{
        }"value": [
     },     "0",
 {         "answer1":
 true,       ]
 "value": {    },
      "bodymapping": "New York",
    [
     "value": 1   {
     }     "response": 0,
}     ],     "questionoutcomes": {
"<p>capital of india is [[New Delhi]]. and capital of USA is [[New York]]</p>" "score": 0.5
    },   "interactions":  { }
   "response1": {    },
  "type": "text",     {
 "options": [         {"response": 1,
          "labeloutcomes": {
"New Delhi",           "valuescore": 0.5
        },  }
      {     }
     "label": "New York",]
    }
  },
  "valueoutcomeDeclaration": 1{
    "maxScore": 1
  },
  "interactionTypes": [
  ]  "text"
  }],
    "validationmedia": [{
 
    "requiredid": "Yesdo_2136875567564144641233",
    }
"type": "image",
 },   "interactionTypessrc": [ "/assets/public/content/assets/do_2136875567564144641233/download.jpg",
    "baseUrl": "texthttps://dev.inquiry.sunbird.org"
  }],
  "name": "Fill In The Blanks",
 
"mimeType": "application/vnd.sunbird.question", "mimeType": "application/vnd.sunbird.question",
  "objectType": "Question",
  "primaryCategory": "FTB Question",
  "qType": "FTB",
  "keyboardConfig": {
    "type": "Device",
    "customKeys": ""
  }
}