semantics.json

[
  {
    "name": "taskDescription",
    "label": "Task description",
    "type": "text",
    "widget": "html",
    "importance": "high",
    "description": "Describe your task here.",
    "enterMode": "div",
    "tags": [
      "strong",
      "em",
      "u",
      "a",
      "ul",
      "ol",
      "h2",
      "h3",
      "hr",
      "pre",
      "code"
    ],
    "optional": true
  },
  {
    "name": "words",
    "label": "words",
    "importance": "high",
    "type": "list",
    "widgets": [
      {
        "name": "VerticalTabs",
        "label": "Default"
      }
    ],
    "min": 2,
    "entity": "Word",
    "field": {
      "name": "word",
      "type": "group",
      "label": "Word",
      "fields": [
        {
          "name": "clue",
          "type": "text",
          "label": "Clue",
          "description": "Clue that should point to the answer.",
          "importance": "medium"
        },
        {
          "name": "answer",
          "type": "text",
          "label": "Answer",
          "description": "Answer to the clue.",
          "importance": "medium"
        },
        {
          "name": "extraClue",
          "type": "library",
          "label": "Extra clue",
          "optional": true,
          "options": [
            "H5P.AdvancedText 1.1",
            "H5P.Image 1.1",
            "H5P.Audio 1.5",
            "H5P.Video 1.6"
          ]
        },
        {
          "name": "fixWord",
          "type": "boolean",
          "label": "Fix word on grid",
          "description": "Check if you want to fix the word to a particular position on the grid. Words with the same alignment may not be placed touching each other.",
          "importance": "low",
          "default": false,
          "optional": true
        },
        {
          "name": "row",
          "type": "number",
          "label": "Row",
          "description": "Row index where the answer should start.",
          "min": 1,
          "max": 100,
          "importance": "low",
          "widget": "showWhen",
          "showWhen": {
            "rules": [
              {
                "field": "fixWord",
                "equals": true
              }
            ]
          }
        },
        {
          "name": "column",
          "type": "number",
          "label": "Column",
          "description": "Column index where the answer should start.",
          "min": 1,
          "max": 100,
          "importance": "low",
          "widget": "showWhen",
          "showWhen": {
            "rules": [
              {
                "field": "fixWord",
                "equals": true
              }
            ]
          }
        },
        {
          "name": "orientation",
          "type": "select",
          "label": "Orientation",
          "description": "Orientation for the answer.",
          "options": [
            {
              "value": "across",
              "label": "Across"
            },
            {
              "value": "down",
              "label": "Down"
            }
          ],
          "default": "across",
          "widget": "showWhen",
          "showWhen": {
            "rules": [
              {
                "field": "fixWord",
                "equals": true
              }
            ]
          }
        }
      ]
    }
  },
  {
    "name": "solutionWord",
    "type": "text",
    "label": "Overall solution word",
    "description": "Optionally add a solution word that can be derived from particular characters on the grid. It will only be visible if all its characters can be found in the crossword. Please note: There's no accessibility support for this feature yet.",
    "importance": "low",
    "optional": "true"
  },
  {
    "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": "theme",
    "type": "group",
    "label": "Theme",
    "importance": "low",
    "fields": [
      {
        "name": "backgroundImage",
        "label": "Background image",
        "type": "image",
        "description": "Select an optional background image. It will be scaled to fit the background without stretching it.",
        "importance": "low",
        "optional": true
      },
      {
        "name": "backgroundColor",
        "type": "text",
        "label": "Background color",
        "description": "Choose a background color. It will either be used instead of a background image or as background for transparent areas.",
        "importance": "low",
        "optional": true,
        "default": "#173354",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "gridColor",
        "type": "text",
        "label": "Grid color",
        "description": "Choose a color for the grid.",
        "importance": "low",
        "optional": true,
        "default": "#000000",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "cellBackgroundColor",
        "type": "text",
        "label": "Cell background color",
        "description": "Choose the background color for a table cell.",
        "importance": "low",
        "optional": true,
        "default": "#ffffff",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "cellColor",
        "type": "text",
        "label": "Cell text color",
        "description": "Choose the text color for a table cell.",
        "importance": "low",
        "optional": true,
        "default": "#000000",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "clueIdColor",
        "type": "text",
        "label": "Clue id color",
        "description": "Choose the color of the clue id inside a table cell.",
        "importance": "low",
        "optional": true,
        "default": "#606060",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "cellBackgroundColorHighlight",
        "type": "text",
        "label": "Cell background color (highlighted)",
        "description": "Choose the background color for a table cell that is highlighted.",
        "importance": "low",
        "optional": true,
        "default": "#3e8de8",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "cellColorHighlight",
        "type": "text",
        "label": "Cell text color (highlighted)",
        "description": "Choose the text color for a table cell that is highlighted.",
        "importance": "low",
        "optional": true,
        "default": "#ffffff",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      },
      {
        "name": "clueIdColorHighlight",
        "type": "text",
        "label": "Cell id color (highlighted)",
        "description": "Choose the color of the clue id inside a table cell that is highlighted.",
        "importance": "low",
        "optional": true,
        "default": "#e0e0e0",
        "widget": "colorSelector",
        "spectrum": {
          "showInput": true,
          "showInitial": true
        }
      }
    ]
  },
  {
    "name": "behaviour",
    "type": "group",
    "label": "Behavioural settings",
    "importance": "low",
    "description": "These options will let you control how the task behaves.",
    "fields": [
      {
        "name": "poolSize",
        "type": "number",
        "min": 2,
        "label": "Number of words to be shown",
        "importance": "low",
        "description": "Create a randomized batch of words from the pool. The batch will always contain at least all the words that were fixed on the grid regardless of this setting. An empty value or 0 means to use all words.",
        "optional": true
      },
      {
        "name": "enableInstantFeedback",
        "label": "Enable instant feedback",
        "type": "boolean",
        "importance": "low",
        "default": false
      },
      {
        "name": "scoreWords",
        "label": "Score words",
        "description": "If this option is enabled, words will be counted in order to determine the score. Otherwise, correct characters will be counted.",
        "type": "boolean",
        "importance": "low",
        "default": true
      },
      {
        "name": "applyPenalties",
        "label": "Apply penalties",
        "description": "If this option is enabled, each wrong answer will be given a penalty score of -1.",
        "type": "boolean",
        "importance": "low",
        "default": false,
        "optional": true
      },
      {
        "name": "enableRetry",
        "label": "Enable \"Retry\"",
        "type": "boolean",
        "importance": "low",
        "default": true,
        "optional": true
      },
      {
        "name": "enableSolutionsButton",
        "label": "Enable \"Solution\"",
        "type": "boolean",
        "importance": "low",
        "default": true,
        "optional": true
      },
      {
        "name": "keepCorrectAnswers",
        "type": "boolean",
        "label": "Keep correct answers on retry",
        "description": "If this option is enabled, correct answers will be kept when the user retries the task unless full score was achieved.",
        "importance": "low",
        "default": false,
        "optional": true,
        "widget": "showWhen",
        "showWhen": {
          "rules": [
            {
              "field": "enableRetry",
              "equals": true
            }
          ],
          "nullWhenHidden": true
        }
      }
    ]
  },
  {
    "name": "l10n",
    "type": "group",
    "common": true,
    "label": "User interface",
    "importance": "low",
    "fields": [
      {
        "name": "across",
        "type": "text",
        "label": "Label for across",
        "importance": "low",
        "default": "Across"
      },
      {
        "name": "down",
        "type": "text",
        "label": "Label for down",
        "importance": "low",
        "default": "Down"
      },
      {
        "name": "checkAnswer",
        "type": "text",
        "label": "Text for \"Check\" button",
        "importance": "low",
        "default": "Check"
      },
      {
        "name": "submitAnswer",
        "type": "text",
        "label": "Text for \"Submit\" button",
        "importance": "low",
        "default": "Submit"
      },
      {
        "name": "tryAgain",
        "label": "Text for \"Retry\" button",
        "type": "text",
        "importance": "low",
        "default": "Retry"
      },
      {
        "name": "showSolution",
        "type": "text",
        "label": "Text for \"Show solution\" button",
        "importance": "low",
        "default": "Show solution"
      },
      {
        "name": "couldNotGenerateCrossword",
        "type": "text",
        "label": "Cannot create crossword",
        "importance": "low",
        "default": "Could not generate a crossword with the given words. Please try again with fewer words or words that have more characters in common."
      },
      {
        "name": "couldNotGenerateCrosswordTooFewWords",
        "type": "text",
        "label": "Cannot create crossword (too few words)",
        "importance": "low",
        "default": "Could not generate a crossword. You need at least two words."
      },
      {
        "name": "probematicWords",
        "type": "text",
        "label": "Probematic words",
        "description": "List words that caused trouble while generating the crossword. @words is a placeholder that will be replaced by the actual problematic words.",
        "importance": "low",
        "default": "Some words could not be placed. If you are using fixed words, please make sure that their position doesn't prevent other words from being placed. Words with the same alignment may not be placed touching each other. Problematic word(s): @words"
      },
      {
        "name": "extraClue",
        "type": "text",
        "label": "Extra clue",
        "importance": "low",
        "default": "Extra clue"
      },
      {
        "name": "closeWindow",
        "type": "text",
        "label": "Close window",
        "importance": "low",
        "default": "Close window"
      }
    ]
  },
  {
    "name": "a11y",
    "type": "group",
    "common": true,
    "label": "Readspeaker",
    "importance": "low",
    "fields": [
      {
        "name": "crosswordGrid",
        "type": "text",
        "label": "Crossword grid description",
        "importance": "low",
        "default": "Crossword grid. Use arrow keys to navigate and the keyboard to enter characters. Alternatively, use Tab to navigate to type the answers in Fill in the Blanks style fields instead of the grid."
      },
      {
        "name": "column",
        "type": "text",
        "label": "Column",
        "importance": "low",
        "default": "Column"
      },
      {
        "name": "row",
        "type": "text",
        "label": "Row",
        "importance": "low",
        "default": "Row"
      },
      {
        "name": "across",
        "type": "text",
        "label": "Across",
        "importance": "low",
        "default": "Across"
      },
      {
        "name": "down",
        "type": "text",
        "label": "Down",
        "importance": "low",
        "default": "Down"
      },
      {
        "name": "empty",
        "type": "text",
        "label": "Empty",
        "importance": "low",
        "default": "Empty"
      },
      {
        "name": "resultFor",
        "description": "Result announcer. @clue is a variable and will be replaced by the respective clue.",
        "type": "text",
        "label": "Result for",
        "importance": "low",
        "default": "Result for: @clue"
      },
      {
        "name": "correct",
        "type": "text",
        "label": "Correct",
        "importance": "low",
        "default": "Correct"
      },
      {
        "name": "wrong",
        "type": "text",
        "label": "Wrong",
        "importance": "low",
        "default": "Wrong"
      },
      {
        "name": "point",
        "type": "text",
        "label": "Point",
        "importance": "low",
        "default": "point"
      },
      {
        "name": "solutionFor",
        "description": "Solution announcer. @clue and @solution are variables and will be replaced by the respective values.",
        "type": "text",
        "label": "Solution for",
        "importance": "low",
        "default": "For @clue the solution is: @solution"
      },
      {
        "name": "extraClueFor",
        "description": "Extra clue announcer. @clue is a variable and will be replaced by the respective value.",
        "type": "text",
        "label": "Extra clue for",
        "importance": "low",
        "default": "Open extra clue for @clue"
      },
      {
        "name": "letterSevenOfNine",
        "description": "Announcing the current position. @position and @length are variables and will be replaced by their respective values.",
        "type": "text",
        "label": "Letter",
        "importance": "low",
        "default": "Letter @position of @length"
      },
      {
        "name": "lettersWord",
        "description": "Announcing the word length. @length is a variable and will be replaced by the respective value.",
        "type": "text",
        "label": "Length of word",
        "importance": "low",
        "default": "@length letter word"
      },
      {
        "name": "check",
        "type": "text",
        "label": "Assistive technology description for \"Check\" button",
        "importance": "low",
        "default": "Check the characters. The responses will be marked as correct, incorrect, or unanswered."
      },
      {
        "name": "showSolution",
        "type": "text",
        "label": "Assistive technology description for \"Show Solution\" button",
        "importance": "low",
        "default": "Show the solution. The crossword will be filled with its correct solution."
      },
      {
        "name": "retry",
        "type": "text",
        "label": "Assistive technology description for \"Retry\" button",
        "importance": "low",
        "default": "Retry the task. Reset all responses and start the task over again."
      },
      {
        "name": "yourResult",
        "type": "text",
        "label": "Your result",
        "description": "@score and @total are variables and will be replaced by their respective values.",
        "importance": "low",
        "default": "You got @score out of @total points"
      }
    ]
  }
]