h5p-question-set/semantics.json

[
  {
    "name": "title",
    "type": "text",
    "label": "Title",
    "description": "Question set title (optional)."
  },
  {
    "name": "randomOrder",
    "type": "boolean",
    "label": "Randomize order",
    "description": "Whether questions should be shown in random order."
  },
  {
    "name": "initialQuestion",
    "type": "number",
    "label": "Initial question",
    "description": "Which question to start with. Count from 0.",
    "default": 0
  },
  {
    "name": "backgroundImage",
    "type": "image",
    "label": "Background image",
    "optional": true,
    "description": "An optional background image for the Question set."
  },
  {
    "name": "progressType",
    "type": "select",
    "label": "Progress indicator",
    "description": "Question set progress indicator style.",
    "options": [
      {
        "value": "textual",
        "label": "Textual"
      },
      {
        "value": "dots",
        "label": "Dots"
      }
    ],
    "default": "textual"
  },
  {
    "name": "passPercentage",
    "type": "number",
    "label": "Pass percentage",
    "description": "Percentage of total score required for passing the quiz.",
    "min": 0,
    "max": 100,
    "step": 1,
    "default": 50
  },
  {
    "name": "questions",
    "label": "Questions",
    "type": "list",
    "entity": "question",
    "field": {
      "name": "question",
      "type": "group",
      "label": "Question",
      "fields": [
        {
          "name": "library",
          "type": "library",
          "label": "Question library",
          "description": "Library for this question.",
          "options": [
            "H5P.MultiChoice 1.0"
          ]
        }
      ]
    }
  },
  {
    "name": "introPage",
    "type": "group",
    "label": "Quiz introduction",
    "fields": [
      {
        "name": "showIntroPage",
        "type": "boolean",
        "label": "Display introduction"
      },
      {
        "name": "title",
        "type": "text",
        "label": "Title",
        "optional": true,
        "description": "This title will be displayed above the introduction text."
      },
      {
        "name": "introduction",
        "type": "text",
        "widget": "textarea",
        "label": "Introduction text",
        "optional": true,
        "description": "This text will be displayed before the quiz starts."
      },
      {
        "name": "startButtonText",
        "type": "text",
        "label": "Start button text",
        "optional": true,
        "placeholder": "Start Quiz",
        "default": "Start Quiz"
      }
    ]
  },
  {
    "name": "texts",
    "type": "group",
    "label": "Interface texts in quiz",
    "common": true,
    "fields": [
      {
        "name": "prevButton",
        "type": "text",
        "label": "Back button",
        "default": "Previous"
      },
      {
        "name": "nextButton",
        "type": "text",
        "label": "Next button",
        "default": "Next"
      },
      {
        "name": "finishButton",
        "type": "text",
        "label": "Finish button",
        "default": "Finish"
      },
      {
        "name": "textualProgress",
        "type": "text",
        "label": "Progress text",
        "description": "Text used if textual progress is selected.",
        "default": "Question: @current of @total questions"
      }
    ]
  },
  {
    "name": "endGame",
    "type": "group",
    "label": "Quiz finished",
    "fields": [
      {
        "name": "showResultPage",
        "type": "boolean",
        "label": "Display results",
        "default": true
      },
      {
        "name": "successGreeting",
        "type": "text",
        "label": "Quiz passed title",
        "placeholder": "Congratulations!",
        "default": "Congratulations!",
        "description": "This title will be displayed above results if the user has successfully passed the quiz."
      },
      {
        "name": "successComment",
        "type": "text",
        "widget": "textarea",
        "label": "Passed comment",
        "default": "You did very well!",
        "description": "This comment will be displayed after the score if the user has successfully passed the quiz."
      },
      {
        "name": "failGreeting",
        "type": "text",
        "label": "Quiz failed title",
        "placeholder": "Oh, no!",
        "default": "Oh, no!",
        "description": "This title will be displayed above the results if the user has failed the quiz."
      },
      {
        "name": "failComment",
        "type": "text",
        "widget": "textarea",
        "label": "Failed comment",
        "default": "This didn't go so well.",
        "description": "This comment will be displayed after the score if the user has failed the quiz."
      },
      {
        "name": "finishButtonText",
        "type": "text",
        "label": "Finish button text",
        "default": "Finish",
        "description": "Text for the finish button."
      },
      {
        "name": "showAnimations",
        "type": "boolean",
        "label": "Display video before quiz results"
      },
      {
        "name": "skippable",
        "type": "boolean",
        "label": "Enable skip video button"
      },
      {
        "name": "skipButtonText",
        "type": "text",
        "label": "Skip video button label",
        "default": "Skip video",
        "description": "This is the label for the button which allows users to skip videos after a quiz.",
        "common": true
      },
      {
        "name": "successVideo",
        "type": "video",
        "label": "Passed video",
        "optional": true,
        "description": "This video will be played if the user successfully passed the quiz."
      },
      {
        "name": "failVideo",
        "type": "video",
        "label": "Fail video",
        "optional": true,
        "description": "This video will be played if the user failes the quiz."
      }
    ]
  }
]