Crate mdbook_quiz_schema
source ·Expand description
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§
- A Markdown string.
- A question where users select among several possible answers.
- An answer for a
MultipleChoice
question. - A prompt for a
MultipleChoice
question. - Fields common to all question types.
- A quiz is the top-level data structure in mdbook-quiz. It represents a sequence of questions.
- A question where users type in a response.
- An answer for a
ShortAnswer
question. - A prompt for a
ShortAnswer
question. - A question where users guess the output of a program.
- An answer for a
Tracing
question. - A prompt for a
Tracing
question.
Enums§
- The type of response for a
MultipleChoice
question. - An individual question. One of several fixed types.
- The kind of response format (and subsequent input method) that accompanies a given short answer questions.