Crate mdbook_quiz_schema

The schema for questions used in mdbook-quiz. Intended to be deserialized from a TOML file. See Quiz as the top-level type. Here is an example of a quiz:

[[questions]]
id = "b230bed3-d6ba-4048-8b06-aa655d837b04"
type = "MultipleChoice"
prompt.prompt = "What is 1 + 1?"
prompt.distractors = ["1", "3", "**infinity**"]
answer.answer = ["2"]
context = """
Consult your local mathematician for details.
""""

Note that all Rust identifiers with multiple words (e.g. does_compile) use camelCase keys, so should be written as doesCompile in the TOML.

Structs

Markdown

A Markdown string.

MultipleChoice

A question where users select among several possible answers.

MultipleChoiceAnswer

An answer for a MultipleChoice question.

MultipleChoicePrompt

A prompt for a MultipleChoice question.

QuestionFields

Fields common to all question types.

Quiz

A quiz is the top-level data structure in mdbook-quiz. It represents a sequence of questions.

ShortAnswer

A question where users type in a response.

ShortAnswerAnswer

An answer for a ShortAnswer question.

ShortAnswerPrompt

A prompt for a ShortAnswer question.

Tracing

A question where users guess the output of a program.

TracingAnswer

An answer for a Tracing question.

TracingPrompt

A prompt for a Tracing question.

Enums

MultipleChoiceAnswerFormat

The type of response for a MultipleChoice question.

Question

An individual question. One of several fixed types.

ShortAnswerResponseFormat

The kind of response format (and subsequent input method) that accompanies a given short answer questions.