Fix: Expanded feedback to add images and more control (fixes #222)

[oliverfoster]

fixes #222

This behaviour is fully backward compatible if the old style of _feedback objects are used. The new style feedback can be used in the new AAT and if building by hand, it will not be supported in the classic AAT

New

• Added object style for feedback states, at _feedback._correct, _feedback._partlyCorrectNotFinal, _feedback._partlyCorrectFinal, _feedback._incorrectNotFinal ,_feedback._incorrectFinal and for _items[].feedback

{
  "altTitle": "",
  "title": "",
  "body": "Incorrect feedback final",
  "_classes": "",
  "_imageAlignment": "left",
  "_graphic": {
    "_src": "course/en/images/single-width.png",
    "alt": "test",
    "attribution": ""
  }
}

Removed

• QuestionModel functions to be replaced with simpler getFeedback function
  • setupCorrectFeedback
  • setupPartlyCorrectFeedback
  • setupIncorrectFeedback
  • setupAttemptSpecificFeedback

Fix

• Block helper compare can now be used as a boolean helper

Testing

1. Requires Update: Switch to model.getFeedback allowing more complex feedback objects adapt-contrib-tutor#79
2. Use the following json for 'c-60':

{
        "_id": "c-60",
        "_parentId": "b-40",
        "_type": "component",
        "_component": "mcq",
        "_classes": "",
        "_layout": "left",
        "_attempts": 3,
        "_questionWeight": 1,
        "_canShowModelAnswer": true,
        "_shouldDisplayAttempts": false,
        "_isRandom": true,
        "_selectable": 1,
        "title": "Multiple Choice Question",
        "displayTitle": "Multiple Choice Question 1sel 1att new",
        "body": "In what year was the first recorded instance of a large scale assessment that consists solely of multiple choice questions?",
        "instruction": "Choose one option and select Submit.",
        "_items": [
          {
            "text": "1917",
            "_shouldBeSelected": true
          },
          {
            "text": "1888",
            "_shouldBeSelected": false,
            "feedback": "Item specific 1888 incorrect feedback"
          },
          {
            "text": "1953",
            "_shouldBeSelected": false,
            "feedback": {
                "altTitle": "",
                "title": "Item specific 1953 incorrect feedback",
                "body": "Item specific 1953 incorrect feedback",
                "_imageAlignment": "right",
                "_graphic": {
                  "_src": "course/en/images/single-width.png",
                  "alt": "test",
                  "attribution": ""
                }
            }
          },
          {
            "text": "1977",
            "_shouldBeSelected": false,
            "feedback": "Item specific 1977 incorrect feedback"
          }
        ],
        "_feedback": {
          "altTitle": "",
          "title": "Feedback global title",
          "_classes": "",
          "_correct": {
            "altTitle": "",
            "title": "",
            "body": "Correct feedback final",
            "_classes": "",
            "_imageAlignment": "left",
            "_graphic": {
              "_src": "course/en/images/single-width.png",
              "alt": "test",
              "attribution": ""
            }
          },
          "_incorrectNotFinal": {
            "altTitle": "",
            "title": "",
            "body": "Incorrect feedback not final",
            "_classes": "",
            "_imageAlignment": "right",
            "_graphic": {
              "_src": "course/en/images/single-width.png",
              "alt": "test",
              "attribution": ""
            }
          },
          "_incorrectFinal": {
            "altTitle": "",
            "title": "",
            "body": "Incorrect feedback final",
            "_classes": "",
            "_imageAlignment": "left",
            "_graphic": {
              "_src": "course/en/images/single-width.png",
              "alt": "test",
              "attribution": ""
            }
          }
        },
        "_pageLevelProgress": {
          "_isEnabled": true,
          "_isCompletionIndicatorEnabled": true
        }
    }

Requires
ref adaptlearning/adapt-contrib-tutor#79

Todo

• Schemas - will do in a separate pr (needs wider coordination)
• Vanilla course - will do in a separate pr (adapt_framework)
• Documentation - (wiki updates needed)

[kirsty-hames]

The testing json, 'c-60' provided above is missing a closing bracket for _incorrectNotFinal._graphic

[kirsty-hames]

No problems testing this but I've raised a couple of queries around the popup layout.

[kirsty-hames]

I've just committed my suggestions to notify.less and notifyPopup.hbs. A couple of things to note:

• Currently, the image rendering is dependent on _imageAlignment so I think we should set a default of right? Otherwise if someone forgets to set this the image wont display.
• Although I've updated the alignment selectors for consistency with other popup alignment classes. Should we be using the same attribute _imageAlignment elsewhere instead of classes? For AAT users, having config is more user friendly then having to apply classes. Perhaps there's an argument to make core plugin classes config and keep classes to the theme?

[joe-allen-89]

Working as expected with FW v5.22.4.

[cahirodoherty-learningpool]

👀

[github-actions]

🎉 This PR is included in version 6.20.5 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀