h5p-question-set/semantics.json

[
  {
    "name": "introPage",
    "type": "group",
    "label": "Quiz introduction",
    "importance": "medium",
    "fields": [
      {
        "name": "showIntroPage",
        "type": "boolean",
        "label": "Display introduction",
        "importance": "low"
      },
      {
        "name": "title",
        "type": "text",
        "label": "Title",
        "importance": "high",
        "optional": true,
        "description": "This title will be displayed above the introduction text.",
        "tags": [
          "sub",
          "sup",
          "strong",
          "em"
        ]
      },
      {
        "name": "introduction",
        "type": "text",
        "widget": "html",
        "label": "Introduction text",
        "importance": "medium",
        "optional": true,
        "description": "This text will be displayed before the quiz starts.",
        "enterMode": "p",
        "tags": [
          "sub",
          "sup",
          "strong",
          "em",
          "p"
        ]
      },
      {
        "name": "startButtonText",
        "type": "text",
        "label": "Start button text",
        "importance": "low",
        "optional": true,
        "default": "Start Quiz"
      },
      {
        "name": "backgroundImage",
        "type": "image",
        "label": "Background image",
        "importance": "low",
        "optional": true,
        "description": "An optional background image for the introduction."
      }
    ]
  },
  {
    "name": "backgroundImage",
    "type": "image",
    "label": "Background image",
    "importance": "low",
    "optional": true,
    "description": "An optional background image for the Question set."
  },
  {
    "name": "progressType",
    "type": "select",
    "label": "Progress indicator",
    "importance": "low",
    "description": "Question set progress indicator style.",
    "options": [
      {
        "value": "textual",
        "label": "Textual"
      },
      {
        "value": "dots",
        "label": "Dots"
      }
    ],
    "default": "dots"
  },
  {
    "name": "passPercentage",
    "type": "number",
    "label": "Pass percentage",
    "importance": "low",
    "description": "Percentage of Total score required for passing the quiz.",
    "min": 0,
    "max": 100,
    "step": 1,
    "default": 50
  },
  {
    "name": "questions",
    "label": "Questions",
    "importance": "high",
    "type": "list",
    "widgets": [
      {
        "name": "VerticalTabs",
        "label": "Default"
      },
      {
        "name": "QuestionSetTextualEditor",
        "label": "Textual"
      }
    ],
    "min": 1,
    "entity": "question",
    "field": {
      "name": "question",
      "type": "library",
      "label": "Question type",
      "importance": "high",
      "description": "Library for this question.",
      "options": [
        "H5P.MultiChoice 1.13",
        "H5P.DragQuestion 1.13",
        "H5P.Blanks 1.11",
        "H5P.MarkTheWords 1.9",
        "H5P.DragText 1.8",
        "H5P.TrueFalse 1.5",
        "H5P.Essay 1.2"
      ]
    }
  },
  {
    "name": "texts",
    "type": "group",
    "label": "Interface texts in quiz",
    "importance": "low",
    "common": true,
    "fields": [
      {
        "name": "prevButton",
        "type": "text",
        "label": "Back button",
        "importance": "low",
        "default": "Previous question"
      },
      {
        "name": "nextButton",
        "type": "text",
        "label": "Next button",
        "importance": "low",
        "default": "Next question"
      },
      {
        "name": "finishButton",
        "type": "text",
        "label": "Finish button",
        "importance": "low",
        "default": "Finish"
      },
      {
        "name": "textualProgress",
        "type": "text",
        "label": "Progress text",
        "importance": "low",
        "description": "Text used if textual progress is selected.",
        "default": "Question: @current of @total questions",
        "tags": [
          "strong",
          "em"
        ]
      },
      {
        "name": "jumpToQuestion",
        "type": "text",
        "label": "Label for jumping to a certain question",
        "importance": "low",
        "description": "You must use the placeholder '%d' instead of the question number, and %total instead of total amount of questions.",
        "default": "Question %d of %total"
      },
      {
        "name": "questionLabel",
        "type": "text",
        "label": "Copyright dialog question label",
        "importance": "low",
        "default": "Question"
      },
      {
        "name": "readSpeakerProgress",
        "type": "text",
        "label": "Readspeaker progress",
        "importance": "low",
        "description": "May use @current and @total question variables",
        "default": "Question @current of @total"
      },
      {
        "name": "unansweredText",
        "type": "text",
        "label": "Unanswered question text",
        "importance": "low",
        "default": "Unanswered"
      },
      {
        "name": "answeredText",
        "type": "text",
        "label": "Answered question text",
        "importance": "low",
        "default": "Answered"
      },
      {
        "name": "currentQuestionText",
        "type": "text",
        "label": "Current question text",
        "importance": "low",
        "default": "Current question"
      }
    ]
  },
  {
    "name": "disableBackwardsNavigation",
    "type": "boolean",
    "label": "Disable backwards navigation",
    "importance": "low",
    "description": "This option will only allow you to move forward in Question Set",
    "optional": true,
    "default": false
  },
  {
    "name": "randomQuestions",
    "type": "boolean",
    "label": "Randomize questions",
    "importance": "low",
    "description": "Enable to randomize the order of questions on display.",
    "default": false
  },
  {
    "name": "poolSize",
    "type": "number",
    "min": 1,
    "label": "Number of questions to be shown:",
    "importance": "low",
    "description": "Create a randomized batch of questions from the total.",
    "optional": true
  },
  {
    "name": "endGame",
    "type": "group",
    "label": "Quiz finished",
    "importance": "medium",
    "fields": [
      {
        "name": "showResultPage",
        "type": "boolean",
        "label": "Display results",
        "importance": "low",
        "default": true
      },
      {
        "name": "showSolutionButton",
        "type": "boolean",
        "label": "Display solution button",
        "default": true
      },
      {
        "name": "showRetryButton",
        "type": "boolean",
        "label": "Display retry button",
        "default": true
      },
      {
        "name": "noResultMessage",
        "type": "text",
        "label": "No results message",
        "importance": "low",
        "description": "Text displayed on end page when \"Display results\" is disabled",
        "default": "Finished",
        "optional": true
      },
      {
        "name": "message",
        "type": "text",
        "label": "Feedback heading",
        "importance": "low",
        "default": "Your result:",
        "description": "This heading will be displayed at the end of the quiz when the user has answered all questions.",
        "tags": [
          "strong",
          "em"
        ]
      },
      {
        "name": "overallFeedback",
        "type": "group",
        "label": "Overall Feedback",
        "importance": "low",
        "expanded": true,
        "fields": [
          {
            "name": "overallFeedback",
            "type": "list",
            "widgets": [
              {
                "name": "RangeList",
                "label": "Default"
              }
            ],
            "importance": "high",
            "label": "Define custom feedback for any score range",
            "description": "Click the \"Add range\" button to add as many ranges as you need. Example: 0-20% Bad score, 21-91% Average Score, 91-100% Great Score!",
            "entity": "range",
            "min": 1,
            "defaultNum": 1,
            "optional": true,
            "field": {
              "name": "overallFeedback",
              "type": "group",
              "importance": "low",
              "fields": [
                {
                  "name": "from",
                  "type": "number",
                  "label": "Score Range",
                  "min": 0,
                  "max": 100,
                  "default": 0,
                  "unit": "%"
                },
                {
                  "name": "to",
                  "type": "number",
                  "min": 0,
                  "max": 100,
                  "default": 100,
                  "unit": "%"
                },
                {
                  "name": "feedback",
                  "type": "text",
                  "label": "Feedback for defined score range",
                  "importance": "low",
                  "placeholder": "Fill in the feedback",
                  "optional": true
                }
              ]
            }
          }
        ]
      },
      {
        "name": "oldFeedback",
        "type": "group",
        "label": "Old Feedback",
        "importance": "low",
        "deprecated": true,
        "fields": [
          {
            "name": "successGreeting",
            "type": "text",
            "label": "Quiz passed greeting",
            "importance": "low",
            "optional": true,
            "description": "This text will be displayed above the score if the user has successfully passed the quiz.",
            "tags": [
              "strong",
              "em"
            ]
          },
          {
            "name": "successComment",
            "type": "text",
            "widget": "html",
            "label": "Passed comment",
            "importance": "low",
            "optional": true,
            "description": "This comment will be displayed after the score if the user has successfully passed the quiz.",
            "tags": [
              "sub",
              "sup",
              "strong",
              "em",
              "a",
              "p"
            ]
          },
          {
            "name": "failGreeting",
            "type": "text",
            "label": "Quiz failed title",
            "importance": "low",
            "optional": true,
            "description": "This text will be displayed above the score if the user has failed the quiz.",
            "tags": [
              "strong",
              "em"
            ]
          },
          {
            "name": "failComment",
            "type": "text",
            "widget": "html",
            "label": "Failed comment",
            "importance": "low",
            "optional": true,
            "description": "This comment will be displayed after the score if the user has failed the quiz.",
            "tags": [
              "sub",
              "sup",
              "strong",
              "em",
              "a",
              "p"
            ]
          }
        ]
      },
      {
        "name": "solutionButtonText",
        "type": "text",
        "label": "Solution button label",
        "importance": "low",
        "default": "Show solution",
        "description": "Text for the solution button."
      },
      {
        "name": "retryButtonText",
        "type": "text",
        "label": "Retry button label",
        "importance": "low",
        "default": "Retry",
        "description": "Text for the retry button."
      },
      {
        "name": "finishButtonText",
        "type": "text",
        "label": "Finish button text",
        "importance": "low",
        "default": "Finish"
      },
      {
        "name": "showAnimations",
        "type": "boolean",
        "label": "Display video before quiz results",
        "importance": "low"
      },
      {
        "name": "skippable",
        "type": "boolean",
        "label": "Enable skip video button",
        "importance": "low"
      },
      {
        "name": "skipButtonText",
        "type": "text",
        "label": "Skip video button label",
        "importance": "low",
        "default": "Skip video"
      },
      {
        "name": "successVideo",
        "type": "video",
        "label": "Passed video",
        "importance": "low",
        "optional": true,
        "description": "This video will be played if the user successfully passed the quiz."
      },
      {
        "name": "failVideo",
        "type": "video",
        "label": "Fail video",
        "importance": "low",
        "optional": true,
        "description": "This video will be played if the user fails the quiz."
      }
    ]
  },
  {
    "name": "override",
    "type": "group",
    "label": "Settings for \"Check\", \"Show solution\" and \"Retry\"",
    "importance": "low",
    "optional": true,
    "fields": [
      {
        "name": "checkButton",
        "type": "boolean",
        "label": "Show \"Check\" buttons",
        "importance": "low",
        "description": "This option determines if the \"Check\" button will be shown for all questions.",
        "optional": true,
        "default": true
      },
      {
        "name": "showSolutionButton",
        "type": "select",
        "label": "Override \"Show Solution\" button",
        "importance": "low",
        "description": "This option determines if the \"Show Solution\" button will be shown for all questions, disabled for all or configured for each question individually.",
        "optional": true,
        "widget": "showWhen",
        "showWhen": {
          "rules": [
            {
              "field": "checkButton",
              "equals": true
            }
          ]
        },
        "options": [
          {
            "value": "on",
            "label": "Enabled"
          },
          {
            "value": "off",
            "label": "Disabled"
          }
        ]
      },
      {
        "name": "retryButton",
        "type": "select",
        "label": "Override \"Retry\" button",
        "importance": "low",
        "description": "This option determines if the \"Retry\" button will be shown for all questions, disabled for all or configured for each question individually.",
        "optional": true,
        "widget": "showWhen",
        "showWhen": {
          "rules": [
            {
              "field": "checkButton",
              "equals": true
            }
          ]
        },
        "options": [
          {
            "value": "on",
            "label": "Enabled"
          },
          {
            "value": "off",
            "label": "Disabled"
          }
        ]
      }
    ]
  }
]