semantics.json

[ 
  {
    "name": "info",
    "type": "boolean",
    "label": "Tutorial and Examples: <a href=\"http://www.h5p.rezeau.org\" target=\"_blank\" rel=\"noopener\">Papi Jo's H5P Moodle site</a></span>",
    "description": "<span style=\"color: white;margin-top: -20px;display: table-caption;font-size: large;\">&#9608;</span>"
  },
  {
    "name": "description",
    "type": "text",
    "widget": "html",
    "label": "Task description",
    "importance": "medium",
    "default": "Try to guess the mysterious sentence/word",
    "description": "A guide telling the user how to do this task.",
    "optional": true,
    "tags": [
      "strong",
      "em",
      "u",
      "a",
      "ul",
      "ol",
      "h2",
      "h3",
      "h4",
      "h5",
      "hr"
    ],
    "font": {
      "size": true,
      "family": true,
      "color": true,
      "background": true
    }
  },  
  {
    "name": "wordle",
    "label": "Wordle Option: Guess a word",
    "type": "boolean",
    "importance": "low",
    "default": false,
    "description": "Check this option if you want the player to have to guess single words of 4 to 8 letters instead of sentences.",
    "optional": true
  },
  {
    "name": "playMode",
    "type": "select",
    "label": "Play Mode",
    "importance": "low",
    "description": "Select your play mode",
    "default": "availableSentences",
    "options": [
      {
        "value": "availableSentences",
        "label": "Use available sentences (below)"
      },
      {
        "value": "userSentence",
        "label": "Allow user to enter their own sentence"
      }
    ],
    "widget": "showWhen",
    "showWhen": {
      "rules": [
        {
          "field": "wordle",
          "equals": false
        }
      ]
    }
  },
  {
    "name": "playModeW",
    "type": "select",
    "label": "Play Mode Wordle",
    "importance": "low",
    "description": "Select your play mode",
    "default": "availableSentences",
    "options": [
      {
        "value": "availableSentences",
        "label": "Use available words (below)"
      },
      {
        "value": "userSentence",
        "label": "Allow user to enter their own word"
      }
    ],
    "widget": "showWhen",
    "showWhen": {
      "rules": [
        {
          "field": "wordle",
          "equals": true
        }
      ]
    }
  },
  {
    "name": "enableAudio",
    "label": "Enable \"Audio\"",
    "type": "boolean",
    "importance": "low",
    "default": false,
    "description": "Enable \"Audio\" for the sentences to be guessed?",
    "optional": true,
    "widget": "showWhen",
    "showWhen": {
      "type": "and",
      "rules": [
        {
          "field": "playMode",
          "equals": "availableSentences"
        }
      ]
    }
  },
  {
    "name": "questions",
    "type": "list",
    "label": "Sentences",
    "entity": "sentence",
    "importance": "high",
    "description": "Simply type the sentences/phrases/words to be guessed by the students. You may split word parts with a forward slash e.g. \"An anti/constitut/ion/al act\"",
    "widget": "showWhen",
    "showWhen": {
      "type": "and",
      "rules": [
        {
          "field": "playMode",
          "equals": "availableSentences"
        },
        {
          "field": "wordle",
          "equals": false
        }
      ]
    },
    "widgets": [
      {
        "name": "VerticalTabs",
        "label": "Default"
      }
    ],
    "min": 1,
    "defaultNum": 1,
    "field": {
      "name": "question",
      "type": "group",
      "label": "Question",
      "importance": "high",
      "fields": [
        {
          "name": "sentence",
          "type": "text",
          "label": "Sentence",
          "importance": "high"
        },
        {
          "name": "audio",
          "type": "audio",
          "label": "Audio",
          "description": "Audio for this sentence (optional)",
          "importance": "low",
          "optional": true,
          "widgetExtensions": ["AudioRecorder"],
          "widget": "showWhen",
          "showWhen": {
            "type": "and",
            "rules": [
              {
                "field": "../../playMode",
                "equals": "availableSentences"
              },
              {
                "field": "../../enableAudio",
                "equals": true
              }
            ]
          }
        },
        {  
          "name": "tip",
          "label": "Tip",
          "type": "text",
          "importance": "low",
          "description": "Tip text for this sentence (optional)",
          "optional": true
        }
      ]
    }
  },
  {
    "name": "questionsW",
    "type": "list",
    "label": "Words",
    "entity": "word",
    "importance": "high",
    "description": "Type the words of 4 to 8 letters to be guessed by the students.",
    "widget": "showWhen",
    "showWhen": {
      "type": "and",
      "rules": [
        {
          "field": "playModeW",
          "equals": "availableSentences"
        },
        {
          "field": "wordle",
          "equals": true
        }
      ]
    },
    "widgets": [
      {
        "name": "VerticalTabs",
        "label": "Default"
      }
    ],
    "min": 1,
    "defaultNum": 1,
    "field": {
      "name": "question",
      "type": "group",
      "label": "Word",
      "importance": "high",
      "fields": [
        {
          "name": "sentence",
          "type": "text",
          "maxLength": 8,
          "label": "Word",
          "importance": "high",
          "description": "Type ONE UPPER-CASE word of 4 to 8 letters. No accents!",
          "regexp": {
            "pattern": "^[A-Z]{4,8}$"
          }
        },
        {
          "name": "audio",
          "type": "audio",
          "label": "Audio",
          "description": "Audio for this word (optional)",
          "importance": "low",
          "optional": true,
          "widgetExtensions": ["AudioRecorder"],
          "widget": "showWhen",
          "showWhen": {
            "type": "and",
            "rules": [
              {
                "field": "../../playModeW",
                "equals": "availableSentences"
              },
              {
                "field": "../../enableAudio",
                "equals": true
              }
            ]
          }
        },
        {  
          "name": "tip",
          "label": "Tip",
          "type": "text",
          "optional": true,
          "widget": "showWhen",
          "showWhen": {
            "rules": [
              {
                "field": "../../wordle",
                "equals": true
              }
            ]
          }
        }
      ]
    }
  },
  {
    "name": "behaviour",
    "type": "group",
    "label": "Behavioural settings.",
    "importance": "low",
    "description": "These options will let you control how the task behaves.",
    "optional": true,
    "fields": [      
      {
        "name": "enableRetry",
        "label": "Enable \"Retry\"",
        "type": "boolean",
        "importance": "low",
        "default": false,
        "description": "Add a \"Retry\" button when the game is over. This will simply refresh the current URL. It may not work in some environments, so please check on your platform before enabling it!",
        "optional": true
      },
      {
        "name": "caseSensitive",
        "importance": "low",
        "type": "boolean",
        "default": false,
        "label": "Case sensitive",
        "description": "Makes sure the user input has to be exactly the same as the answer.",
        "widget": "showWhen",
        "showWhen": {
          "rules": [
            {
              "field": "../wordle",
              "equals": false
            }
          ]
        }
      },
      {
        "label": "Enable Number of words Choice",
        "importance": "low",
        "description": "Check this option to allow the user to select the number of words (per sentence) to guess. Do NOT check this option if your sentences make up a story!",
        "name": "enableNumChoice",
        "type": "boolean",
        "default": false,
        "optional": true,
        "widget": "showWhen",
        "showWhen": {
          "type": "and",
          "rules": [
            {
              "field": "../wordle",
              "equals": false
            },
            {
              "field": "../playMode",
              "equals": "availableSentences"
            }
          ]
        }
      },
      {
        "label": "Enable \"Show solution\" button",
        "importance": "low",
        "name": "enableSolutionsButton",
        "type": "boolean",
        "default": false,
        "optional": true,
        "widget": "showWhen",
        "showWhen": {
          "type": "and",
          "rules": [
            {
              "field": "../wordle",
              "equals": false
            },
            {
              "field": "../playMode",
              "equals": "availableSentences"
            }
          ]
        }
      },
      {
        "label": "Enable \"End Game\" button",
        "importance": "low",
        "name": "enableEndGameButton",
        "type": "boolean",
        "default": false,
        "description": "Check this if you want to allow the player to quit the game without having guessed the current sentence",
        "optional": true,
        "widget": "showWhen",
        "showWhen": {
        "type": "and",
          "rules": [
            {
              "field": "../playMode",
              "equals": "availableSentences"
            },
            {
              "field": "enableSolutionsButton",
              "equals": false
            },
            {
              "field": "../wordle",
              "equals":false
            }
          ]
        }
      },
      {
        "name": "numRounds",
        "type": "number",
        "label": "Number of rounds before Solutions or End Game",
        "description": "Minimum number of rounds before the \"Solutions\" or \"End Game\" buttons can be displayed:",
        "importance": "low",
        "optional": true,
        "default": 1,
        "min": 1,
        "widget": "showWhen",
        "showWhen": {
          "type": "or",
          "rules": [
            {
              "field": "enableSolutionsButton",
              "equals": true
            },
            {
              "field": "enableEndGameButton",
              "equals": true
            }
          ]
        }
      },
      {
        "name": "maxTries",
        "type": "number",
        "label": "Maximum number of tries to guess the word (Wordle option)",
        "description": "Maximum number of tries before Game is over and Solution is displayed:",
        "importance": "low",
        "optional": true,
        "default": 6,
        "min": 6,
        "step": 2,
        "widget": "showWhen",
        "showWhen": {
          "type": "and",
          "rules": [
            {
              "field": "../playMode",
              "equals": "availableSentences",
              "field": "../wordle",
              "equals":true
            }
          ]
        }
      },
      {
        "name": "displayAudio",
        "type": "select",
        "label": "When to display the audio buttons",
        "importance": "low",
        "description": "If a sentence has an audio attached to it, select WHEN you want to display the audio buttons.",
        "default": "correct",
        "widget": "showWhen",
          "showWhen": {
            "rules": [
              {
                "field": "../enableAudio",
                "equals": true
              }
            ]
          },
        "options": [
          {
            "value": "correct",
            "label": "Only when the blanks have been correctly filled in"
          },
          {
            "value": "always",
            "label": "Always"
          }
        ]
      },
      {
        "label": "Display Guessed Sentences",
        "importance": "low",
        "name": "listGuessedSentences",
        "description": "Check this to add each guessed sentence to a display list after each successful attempt. This option is useful if your sentences make up a story.",
        "type": "boolean",
        "default": false,
        "widget": "showWhen",
        "showWhen": {
          "rules": [
            {
              "field": "../wordle",
              "equals": false
            }
          ]
        }
      },
      {
        "label": "Display audio and tip buttons in Guessed Sentences",
        "importance": "low",
        "name": "listGuessedAudioAndTips",
        "description": "Select how you want to display the audio and tip buttons in front of each sentence in the list of guessed sentences.",
        "type": "select",
        "default": "none",        
        "widget": "showWhen",
        "showWhen": {
        "type": "and",
          "rules": [
            {
              "field": "../playMode",
              "equals": "availableSentences"
            },
            {
              "field": "listGuessedSentences",
              "equals": true
            },
            {
              "field": "../enableAudio",
              "equals": true
            }
          ]
        },
        "options": [
          {
            "value": "none",
            "label": "None"
          },
          {
            "value": "audioAndTip",
            "label": "Both audio and tip buttons"
          },
          {
            "value": "tipOnly",
            "label": "Tip button only"
          },
          {
            "value": "audioOnly",
            "label": "Audio button only"
          }
        ]
      },
      {
        "name": "sentencesOrder",
        "type": "select",
        "label": "Sentences Order",
        "importance": "low",
        "description": "Select the order in which the sentences will be displayed to the user. Do NOT check this option if your sentences make up a story!",
        "default": "normal",
        "widget": "showWhen",
        "showWhen": {
          "rules": [
            {
              "field": "../wordle",
              "equals":false
            }
          ]
        },
        "options": [
          {
            "value": "normal",
            "label": "Normal order"
          },
          {
            "value": "random",
            "label": "Random order"
          }
        ]
      }
    ]
  },
  {
    "label": "Text for \"Show solutions\" button",
    "name": "showSolutions",
    "type": "text",
    "default": "Show solution",
    "common": true
  },
  {
    "label": "Text for \"New sentence\" button",
    "importance": "low",
    "name": "newSentence",
    "type": "text",
    "default": "Guess another sentence",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"New word\" button",
    "importance": "low",
    "name": "newWord",
    "type": "text",
    "default": "Guess another word",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"End Game\" button",
    "importance": "low",
    "name": "endGame",
    "type": "text",
    "default": "End Game",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"Check\" button",
    "importance": "low",
    "name": "checkAnswer",
    "type": "text",
    "default": "Check",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"Try again\" button",
    "importance": "low",
    "name": "tryAgain",
    "type": "text",
    "default": "Try again",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"Not enough rounds\" message",
    "importance": "low",
    "name": "notEnoughRounds",
    "type": "text",
    "default": "This option won't be available before round @round",
    "description": "@round will be replaced by the minimum number of rounds needed before displaying solutions or ending the game",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"Fill in all the blanks\" message",
    "importance": "low",
    "name": "notFilledOut",
    "type": "text",
    "default": "Please fill in all the blanks before checking your answer!",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"How many words do you want in your mystery sentence?\" message",
    "importance": "low",
    "name": "numWords",
    "type": "text",
    "default": "How many words do you want in your mystery sentence?",
    "common": true,
    "optional": true,
    "description": "Only used if \"Enable Number of words Choice\" is enabled"
  },
  {
    "label": "Text for \"Any number of words\"",
    "importance": "low",
    "name": "anyNumber",
    "type": "text",
    "default": "Any number",
    "common": true,
    "optional": true,
    "description": "Only used if \"Enable Number of words Choice\" is enabled"
  },
  {
    "label": "Text for \"Type a sentence to be guessed by your friends\" message",
    "importance": "low",
    "name": "userSentenceDescriptionLabel",
    "type": "text",
    "default": "Type a sentence to be guessed by your friends",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow users to enter their own sentence\""
  },
  {
    "label": "Text for \"Type ONE UPPER-CASE word of 4 to 8 letters to be guessed by your friends. No accents!\" message",
    "importance": "low",
    "name": "userWordDescriptionLabel",
    "type": "text",
    "default": "Type ONE UPPER-CASE word of 4 to 8 letters to be guessed by your friends. No accents!",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow user to enter their own word\""
  },
  {
    "label": "Text for \"Type a Tip for this sentence (optional)\" message",
    "importance": "low",
    "name": "userSentenceTipLabel",
    "type": "text",
    "default": "Type a Tip for this sentence (optional)",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow users to enter their own sentence\""
  },
  {
    "label": "Text for \"Minimum number of rounds before Solutions can be displayed:\" message",
    "importance": "low",
    "name": "userSentencenumRoundsLabel",
    "type": "text",
    "default": "Minimum number of rounds before Solutions can be displayed:",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow users to enter their own sentence\""
  },
  {
    "label": "Text for \"Maximum number of tries before Game is over and Solution is displayed:\" message",
    "importance": "low",
    "name": "userWordnumRoundsLabel",
    "type": "text",
    "default": "Maximum number of tries before Game is over and Solution is displayed:",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow users to enter their own sentence\" and Wordle option selected."
  },
  {
    "label": "Text for the \"Never show\" radio button choice",
    "importance": "low",
    "name": "userSentenceNeverShow",
    "type": "text",
    "default": "Never show",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow users to enter their own sentence\""
  },
  {
    "label": "Text for the \"No limit\" radio button choice",
    "importance": "low",
    "name": "userWordNoLimit",
    "type": "text",
    "default": "No limit",
    "common": true,
    "optional": true,
    "description": "Only used if playmode is set to \"Allow users to enter their own sentence\" and Wordle option selected."
  },
  {
    "name": "sentence",
    "type": "text",
    "label": "Text for \"sentence\" singular word",
    "description": "This word will be used in various parts of the activity",
    "importance": "low",
    "default": "sentence",
    "common": true,
    "optional": true 
  },
  {
    "name": "sentences",
    "type": "text",
    "label": "Text for \"sentence\" plural word",
    "description": "This word will be used in various parts of the activity",
    "importance": "low",
    "default": "sentences",
    "common": true,
    "optional": true 
  },
  {
    "name": "round",
    "type": "text",
    "label": "Text for \"Round\" message below sentences to be guessed",
    "description": "@round will be replaced by the number of the current round",
    "importance": "low",
    "default": "Round @round",
    "common": true,
    "optional": true 
  },
  {
    "name": "timeSpent",
    "label": "Time spent text",
    "importance": "low",
    "type": "text",
    "default": "Time Spent",
    "description": "Label for showing the time spent while guessing one sentence",
    "common": true,
    "optional": true 
  },
  {
    "name": "scoreExplanationButtonLabel",
    "label": "Score Explanation Button Label",
    "importance": "low",
    "type": "text",
    "default": "Show score explanation",
    "description": "Label for the 'Show score explanation' feedback text",
    "common": true,
    "optional": true 
  },
  {
    "name": "scoreExplanationforSinglePoint",
    "label": "Score Explanation for the Single Point score",
    "importance": "low",
    "type": "text",
    "default": "The maximum score for this activity is 1 and you got the point for any number of sentences guessed.",
    "common": true,
    "optional": true 
  },
  {
    "name": "scoreExplanationforAllSentences",
    "label": "Score Explanation for All Sentences",
    "importance": "low",
    "type": "text",
    "default": "Score = number of guessed sentences / number of sentences in this activity.",
    "common": true,
    "optional": true 
  },
  {
    "name": "scoreExplanationforAllWords",
    "label": "Score Explanation for All Words (Wordle option)",
    "importance": "low",
    "type": "text",
    "default": "Score = number of words found / number of words tried.",
    "common": true,
    "optional": true 
  },
  {
    "name": "scoreExplanationforSentencesWithNumberWords",
    "label": "Score Explanation for All Sentences with selected number of words",
    "importance": "low",
    "type": "text",
    "default": "Score = number of guessed sentences / number of sentences containing @words words.",
    "description": "@words will be replaced by the number of words per sentence selected by the user on the initial screen",
    "common": true,
    "optional": true 
  },
  {
    "name": "summary",
    "label": "Text for the Summary page header",
    "importance": "low",
    "type": "text",
    "default": "Summary",
    "common": true,
    "optional": true 
  },
  {
    "name": "sentencesGuessed",
    "label": "Text for the number of Sentences guessed (on the summary page)",
    "importance": "low",
    "type": "text",
    "default": "Sentences guessed",
    "common": true,
    "optional": true 
  },
  {
    "name": "wordsFound",
    "label": "Text for the number of Words  guessed (on the summary page)",
    "importance": "low",
    "type": "text",
    "default": "Words found: ",
    "common": true,
    "optional": true 
  },
  {
    "name": "wordFound",
    "label": "Text for Word Found (Wordle Option)",
    "importance": "low",
    "type": "text",
    "default": "Word found: ",
    "common": true,
    "optional": true 
  },
  {
    "name": "wordNotFound",
    "label": "Text for Word not found (Wordle option)",
    "importance": "low",
    "type": "text",
    "default": "Word not found: ",
    "common": true,
    "optional": true 
  },
  {
    "name": "solutionsViewed",
    "label": "Text for the number of Solutions viewed (on the summary page)",
    "importance": "low",
    "type": "text",
    "default": "Solutions viewed",
    "common": true,
    "optional": true 
  },
  {
    "name": "totalTimeSpent",
    "label": "Text for the total time spent (on the summary page)",
    "importance": "low",
    "type": "text",
    "default": "Total Time Spent",
    "common": true,
    "optional": true 
  },
  {
    "name": "totalRounds",
    "label": "Text for the total number of rounds used (on the summary page)",
    "importance": "low",
    "type": "text",
    "default": "Total Rounds",
    "common": true,
    "optional": true 
  },
  {
    "label": "Text for \"':ans' is correct\" message",
    "importance": "low",
    "name": "answerIsCorrect",
    "type": "text",
    "default": "':ans' is correct",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"':ans' is wrong\" message",
    "importance": "low",
    "name": "answerIsWrong",
    "type": "text",
    "default": "':ans' is wrong",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"Answered correctly\" message",
    "importance": "low",
    "name": "answeredCorrectly",
    "type": "text",
    "default": "Answered correctly",
    "common": true,
    "optional": true
  },
  {
    "label": "Text for \"Answered incorrectly\" message",
    "importance": "low",
    "name": "answeredIncorrectly",
    "type": "text",
    "default": "Answered incorrectly",
    "common": true,
    "optional": true
  },
  {
    "label": "Assistive technology label for solution",
    "importance": "low",
    "name": "solutionLabel",
    "type": "text",
    "default": "Correct answer:",
    "common": true,
    "optional": true
  },
  {
    "label": "Assistive technology label for input field",
    "importance": "low",
    "name": "inputLabel",
    "type": "text",
    "description": "Use @num and @total to replace current cloze number and total cloze number",
    "default": "Blank input @num of @total",
    "common": true,
    "optional": true
  },
  {
    "label": "Assistive technology label for saying an input has a tip tied to it",
    "importance": "low",
    "name": "inputHasTipLabel",
    "type": "text",
    "default": "Tip available",
    "common": true,
    "optional": true
  },
  {
    "label": "Tip icon label",
    "importance": "low",
    "name": "tipLabel",
    "type": "text",
    "default": "Tip",
    "common": true,
    "optional": true
  },
  {
    "name": "retry",
    "type": "text",
    "label": "Text for the retry button",
    "importance": "low",
    "default": "Retry",
    "common": true
  },
  {
    "label": "End Game confirmation dialog",
    "importance": "low",
    "name": "confirmEndGame",
    "type": "group",
    "common": true,
    "fields": [
      {
        "label": "Header text",
        "importance": "low",
        "name": "header",
        "type": "text",
        "default": "End Game?"
      },
      {
        "label": "Body text",
        "importance": "low",
        "name": "body",
        "type": "text",
        "default": "Are you sure you wish to End this Game?",
        "widget": "html",
        "enterMode": "p",
        "tags": [
          "strong",
          "em",
          "del",
          "u",
          "code"
        ]
      },
      {
        "label": "Cancel button label",
        "importance": "low",
        "name": "cancelLabel",
        "type": "text",
        "default": "Cancel"
      },
      {
        "label": "Confirm button label",
        "importance": "low",
        "name": "confirmLabel",
        "type": "text",
        "default": "OK"
      }
    ]
  }
]