Ordkort

The 60 languages Ordkort teaches and explains in, with their codes.

{
  "type": "object",
  "properties": {}
}

The built-in topics for word lists (greetings, food, the doctor, documents and public services…), with their ids.

{
  "type": "object",
  "properties": {}
}

Words already in Ordkort's shared bank for a topic and level, with translations, forms and examples. Nouns and verbs have been checked against dictionaries. May be empty for a rare pair of languages; then write the words yourself.

{
  "type": "object",
  "properties": {
    "target": {
      "type": "string",
      "description": "A language code from list_languages, such as \"nb\", \"en\", \"uk\""
    },
    "native": {
      "type": "string",
      "description": "A language code from list_languages, such as \"nb\", \"en\", \"uk\""
    },
    "topic": {
      "type": "string",
      "description": "A topic id from list_topics"
    },
    "level": {
      "type": "string",
      "enum": [
        "A1",
        "A2",
        "B1",
        "B2",
        "C1"
      ],
      "default": "A1"
    },
    "count": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 30
    }
  },
  "required": [
    "target",
    "native",
    "topic"
  ]
}

Openly licensed pictures for a word: first the Wikimedia Commons picture of the Wikidata item the word names (found in the word's own language, so "hus" in nb finds a house), then Pixabay's photos and drawings, then Openverse's, sorted so those whose title or tags hold the word come first. Give the bare word without its article, and its language. Each has an image_url to put on a card and a credit to show with it. Look at the credit: it names the picture.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 80,
      "description": "The word, without its article (\"hus\", not \"et hus\")"
    },
    "language": {
      "type": "string",
      "description": "The language of the word (a code from list_languages); default \"en\""
    }
  },
  "required": [
    "query"
  ]
}

How a card is built, the fields and pictures a template can use, and the CSS variables and parts of the site. Read it before create_design.

{
  "type": "object",
  "properties": {}
}

Makes a deck of up to 500 cards and returns a link. When the person opens the link, Ordkort shows the deck and adds it to their cards if they agree. Pictures are given by an https address (for example from find_pictures), and so is the deck's cover (cover_url), a small picture shown instead of the emoji. The link works for a year.

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 80
    },
    "emoji": {
      "type": "string",
      "maxLength": 8
    },
    "cover_url": {
      "type": "string",
      "description": "Optional: an https address of a small picture for the deck, shown instead of the emoji (a square crop of it, 64 px). For example the first result of find_pictures for the topic."
    },
    "cover_credit": {
      "type": "string",
      "description": "Whom to credit for the cover, with the licence"
    },
    "target": {
      "type": "string",
      "description": "A language code from list_languages, such as \"nb\", \"en\", \"uk\""
    },
    "native": {
      "type": "string",
      "description": "A language code from list_languages, such as \"nb\", \"en\", \"uk\""
    },
    "level": {
      "type": "string",
      "enum": [
        "A1",
        "A2",
        "B1",
        "B2",
        "C1"
      ]
    },
    "cards": {
      "type": "array",
      "minItems": 1,
      "maxItems": 500,
      "items": {
        "type": "object",
        "required": [
          "term",
          "translation"
        ],
        "properties": {
          "term": {
            "type": "string",
            "description": "The word in the target language, with its article for a noun (\"et hus\", \"der Hund\")"
          },
          "translation": {
            "type": "string"
          },
          "part_of_speech": {
            "type": "string",
            "enum": [
              "noun",
              "verb",
              "adjective",
              "adverb",
              "preposition",
              "pronoun",
              "conjunction",
              "numeral",
              "interjection",
              "phrase"
            ]
          },
          "pronunciation": {
            "type": "string"
          },
          "grammar": {
            "type": "string"
          },
          "forms": {
            "type": "string",
            "description": "Inflected forms, comma-separated"
          },
          "example": {
            "type": "string"
          },
          "example_translation": {
            "type": "string"
          },
          "image_url": {
            "type": "string",
            "description": "An https address of a picture"
          },
          "image_credit": {
            "type": "string",
            "description": "Whom to credit, with the licence"
          }
        }
      }
    }
  },
  "required": [
    "title",
    "target",
    "native",
    "cards"
  ]
}

Makes a look for Ordkort and returns a link that shows it and applies it if the person agrees. Read design_guide first. front_html and back_html are card templates with fields in double braces: {{term}}, {{translation}}, {{pronunciation}}, {{grammar}}, {{forms}}, {{example}}, {{example_translation}}, {{image}}, {{audio}}, {{deck}}; {{#example}}…{{/example}} shows its inside only when the card has an example. The card's picture: <img src="{{image}}"> or var(--card-image) in CSS. Pictures by https address (CSS url() or <img src>) are fetched once by Ordkort, at most 8. card_css styles the cards, site_css the whole site through CSS variables (--paper, --card, --ink, --blue, --font-serif…). Scripts and event handlers are removed. The answer may carry notes on what will not work as meant.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 80
    },
    "front_html": {
      "type": "string",
      "maxLength": 20000
    },
    "back_html": {
      "type": "string",
      "maxLength": 20000
    },
    "card_css": {
      "type": "string",
      "maxLength": 20000
    },
    "site_css": {
      "type": "string",
      "maxLength": 20000
    }
  },
  "required": [
    "name"
  ]
}