How to format a JSON file
Stem moodle javascript extension

JSON Question and Answer File Format

This documentation explains how to format a JSON file containing questions and answers for a course. The file should follow the specified structure and rules to ensure proper functionality.

File Naming

The file should be named in the following format:

questions_{course_name}.json

course_name is the name of the course the questions are related to.

JSON Structure

The file contains an array of question objects. Each question object should follow this format:

[
    {
        "question": "",
        "options": [
            "",
            "",
            "",
            ""
        ],
        "correctAnswer": 3,
        "image": "path to img",
        "motivation": "reason why selected answer is correct",
        "motivation_image":"path_to_img explaining the motivation in a better way",
        "verified": 1
    },
    {
        "question": "",
        "options": [
            "",
            "",
            "",
            ""
        ],
        "correctAnswer": 2,
        "image": "path to img",
        "motivation": "reason why selected answer is correct",
        "verified": 0
    }
    ...
]

Field Descriptions

question (required): A string representing the question. HTML tags can be used within the question.
```
"question": "What is the capital of France?"
```
options (required): An array of strings, each representing a possible answer to the question. HTML tags can be used within the options.
```
"options": [
 "Berlin",
 "Madrid",
 "Paris",
 "Rome"
]
```
correctAnswer (required):
- For single-choice questions: An integer representing the index (0-based) of the correct answer within the options array.
```
"correctAnswer": 2
```
- For multiple-choice questions: An array of integers representing the indices (0-based) of the correct answers within the options array.
```
"correctAnswer": [1, 3]
```
image (optional): A string representing the path to an image related to the question.
```
"image": "images/paris.jpg"
```
motivation (optional): A string explaining why the selected answer is correct. HTML tags can be used within the motivation.
```
"motivation": "Paris is the capital of France."
```
motivation_image (optional): A string representing the path to an image related to the motivation
```
"motivation_image": "images/eiffel_tower.png"
```
verified (optional): An integer (1 or 0) indicating whether the question has been verified. If verified is 1, it prints a green checkmark; if it is 0, it prints a yellow warning triangle.
```
"verified": 1
```

Example

Here is an example of a properly formatted JSON file:

[
    {
        "question": "What is the <u>capital</u> of France?",
        "options": [
            "Berlin",
            "Madrid",
            "Paris",
            "Rome"
        ],
        "correctAnswer": 2,
        "image": "images/paris.jpg",
        "motivation": "Paris is the capital of France.",
        "motivation_image": "images/eiffel_tower.png",
        "verified": 1
    },
    {
        "question": "Which planet is known as the Red Planet?",
        "options": [
            "Earth",
            "Mars",
            "Jupiter",
            "Saturn"
        ],
        "correctAnswer": 1,
        "image": "images/mars.jpg",
        "motivation": "Mars is known as the Red Planet because of its reddish appearance.",
        "verified": 0
    },
    {
        "question": "Select the <b>prime</b> numbers:",
        "options": [
            "2",
            "3",
            "4",
            "5"
        ],
        "correctAnswer": [0, 1, 3],
        "image": "images/prime_numbers.jpg",
        "motivation": "2, 3, and 5 are prime numbers.",
        "verified": 1
    }
]

Stem moodle javascript extension

This extension lets the user manage his/her courses on STEM moodle (i.e. bookmarking, changing background images...).
To use this, first download Tampermonkey (https://www.tampermonkey.net/) on your browser. Next, open it and click on "add a new script".
Delete all the just-opened file content, copy and paste stem_moodle_extension.js code, save (Ctrl + S) and you're good to go!