ExamFileType

Internal tag named type.

One of the following items:

tag-value	datatype of value	description
template	TemplateFile	An exam that uses a template.
normal	NormalExam	A normal exam.
diagnostic	DiagnosticExam	An exam in diagnostic mode.

TemplateFile

field	type	description
template	String	The path to the template to use. Relative to the `exams` or `questions` folder.
[any]	YAML-value	The data to insert into the template. Maps template keys onto values.

NormalExam

field	type	description
name	Translation	The name of the exam
locales	Array of Locale	All locales for which the exam should be generated
navigation	NormalNavigation	The navigation settings for this exam
timing	Timing	The timing settings for this exam
feedback	Feedback	The feedback settings for this exam
question_groups	Array of QuestionGroup	The questions groups for this exam
numbas_settings	NumbasSettings	The settings to set for numbas

Translation

One of the following items:

type	description
TranslationStruct	A structured translatable string with placeholders.
FileString	A simple filestring. This implies that it can also just be a string.

TranslationStruct

field	type	description
content	TranslationContent	The content with optional placeholders ({{placeholder-name}}).
placeholders	Map from String to Translation	The values for the placeholders. It maps the placeholder-name to it's translatable value. The value for a placeholder can thus (if needed) be different for different locales.

TranslationContent

One of the following items:

type	description
Map from String to FileString	Map from locale to content. You can use this to specify different content for different locales.
FileString	A filestring. Possibly to a file that is placed in `locale` folders and is therefore localized.

FileString

One of the following items:

type description

String A string of the form file:<filepath> where filepath is the relative path (within the exams or questions folder) to a file containing content. This content can be localized by placing it in locale folders. e.g. file:examples/basic-explanation.html will search for files in folders with following form: questions/examples/locale-<localename>/basic-explanation.html If a file isn't found for a specific locale, questions/examples/basic-explanation.html will be used.

String A literal string.

type	description
String	A string of the form `file:<filepath>` where `filepath` is the relative path (within the `exams` or `questions` folder) to a file containing content. This content can be localized by placing it in locale folders. e.g. `file:examples/basic-explanation.html` will search for files in folders with following form: `questions/examples/locale-<localename>/basic-explanation.html` If a file isn't found for a specific locale, `questions/examples/basic-explanation.html` will be used.
String	A literal string.

Locale

field	type	description
name	String	The internal name used for the locale. It is best to use en for English, nl for dutch etc
numbas_locale	SupportedLocale	The locale to use in the Numbas interface

SupportedLocale

One of the following items:

name	description
"ar-SA"	Arabic (Saudi Arabia)
"de-DE"	German (Germany)
"en-GB"	English (United Kingdom)
"es-ES"	Spanish (Spain)
"fr-FR"	French (France)
"he-IL"	Hebrew (Israel)
"in-ID"	Indonesian (Indonesia)
"it-IT"	Italian (Italy)
"ja-JP"	Japanese (Japan)
"ko-KR"	Korean (Korea)
"nb-NO"	Norwegian (Norway)
"nl-NL"	Dutch (Netherlands)
"pl-PL"	Polish (Poland)
"pt-BR"	Portuguese (Brazil)
"sq-AL"	Albanian (Albania)
"sv-SE"	Swedish (Sweden)
"tr-TR"	Turkish (Turkey)
"vi-VN"	Vietnamese (Viet Nam)
"zg-CN"	Chinese (S)

NormalNavigation

Internal tag named mode.

One of the following items:

tag-value	datatype of value	description
sequential	SequentialNavigation	Questions are shown in sequential order. Whether student can browse trough questions in any order, can be set.
menu	MenuNavigation	Questions are shown in a menu and there is no real order of the questions.

SequentialNavigation

field	type	description
start_password	"none" or FileString	Password to begin the exam none and "" are the same
can_regenerate	Boolean	Whether the student can regenerate questions Old name was `allow_regenerate`
show_steps	Boolean	If false, then part steps will not be offered to the student, regardless of whether any have been defined in the exam’s questions Old name was `allow_steps`
show_title_page	Boolean	Whether the title page should be shown. Old name was `show_frontpage`
confirm_when_leaving	Boolean	Whether the student will be asked to confirm when leaving the exam.
show_names_of_question_groups	Boolean	Whether the names of the question groups should be shown.
allow_printing	Boolean	Whether the student is allowed to print the exam
can_move_to_previous	Boolean	Whether the student can move back to previous question (Old name was `reverse`)
browsing_enabled	Boolean	Whether the student can jump to any question.
show_results_page	ShowResultsPage	When the results page should be shown
on_leave	LeaveAction	Action to execute when a student changes question or tries to end the exam.

ShowResultsPage

One of the following items:

name	description
"on_completion"	When the exam is completed.
"never"	Never show it.

LeaveAction

Internal tag named action.

One of the following items:

tag-value	datatype of value	description
"none"		Don't show a warning
warn_if_not_attempted	LeaveActionMessage	Warn when a question is not attempted.
prevent_if_not_attempted	LeaveActionMessage	Prevent when a question is not attempted

LeaveActionMessage

field	type	description
message	Translation	The message to show.

MenuNavigation

field	type	description
start_password	"none" or FileString	Password to begin the exam none and "" are the same
can_regenerate	Boolean	Whether the student can regenerate questions Old name was `allow_regenerate`
show_steps	Boolean	If false, then part steps will not be offered to the student, regardless of whether any have been defined in the exam’s questions Old name was `allow_steps`
show_title_page	Boolean	Whether the title page should be shown. Old name was `show_frontpage`
confirm_when_leaving	Boolean	Whether the student will be asked to confirm when leaving the exam.
show_names_of_question_groups	Boolean	Whether the names of the question groups should be shown.
allow_printing	Boolean	Whether the student is allowed to print the exam

Timing

field	type	description
duration_in_seconds	"none" or Integer	The maximal time that can be spend on the exam. If this value is `none` or 0, the student gets unlimited time.
allow_pause	Boolean	Whether the 'pause' button is available.
on_timeout	TimeoutAction	Action to do on timeout
timed_warning	TimeoutAction	Action to do five minutes before timeout

TimeoutAction

Internal tag named action.

One of the following items:

tag-value	datatype of value	description
"none"		Do nothing
warn	TimeoutActionWarn	Show a warning

TimeoutActionWarn

field	type	description
message	Translation	The message to show

Feedback

field	type	description
percentage_needed_to_pass	"none" or Float	Specifies when a student passes the test. When set to "none" or 0, no percentage will be shown in frontpage.
show_name_of_student	Boolean	Whether the student's name should be shown in the exam.
show_current_marks	Boolean	Whether current marks are shown during exam or not (show_actual_mark in numbas)
show_maximum_marks	Boolean	Whether the maximal mark for a question (or the total exam) is shown (show_total_mark of numbas)
show_answer_state	Boolean	Whether answer feedback is shown (right or wrong etc)
allow_reveal_answer	Boolean	Whether the 'reveal answer' button is present
review	Review	The review settings
advice	Translation	The advice shown at the end.
intro	Translation	The introductory text
feedback_messages	Array of FeedbackMessage	Different feedback messages based on their score.

Review

field	type	description
show_score	Boolean	Whether to show score in result overview page
show_feedback	Boolean	Show feedback while reviewing
show_expected_answer	Boolean	Show expected answer while reviewing
show_advice	Boolean	Show advice while reviewing

FeedbackMessage

field	type	description
message	String	The message to show
threshold	String	The minimum score that is needed to get this feedback

QuestionGroup

field	type	description
name	Translation	The name of the question group. Might be shown to students, based on the `show_names_of_question_groups` setting of the exam navigation.
picking_strategy	PickingStrategy	The strategy to use to pick the questions to show
questions	Array of QuestionPathOrTemplate	The questions

PickingStrategy

Internal tag named type.

One of the following items:

tag-value	datatype of value	description
"all_ordered"		All questions in the group are shown in the given order
"all_shuffled"		All questions in the group are shown in a random order for each attempt
random_subset	PickingStrategyRandomSubset	A random subset of the questions in this group will be shown. The amount of random questions to show, needs to be specified

PickingStrategyRandomSubset

field	type	description
pick_questions	Integer	The amount of questions to pick

QuestionPathOrTemplate

One of the following items:

type	description
String	The path to the question. Relative to the `questions` folder.
TemplateFile	Directly load a templated question by specifying the template values.

NumbasSettings

field	type	description
theme	String	The numbas theme to use

DiagnosticExam

field	type	description
name	Translation	The name of the exam
locales	Array of Locale	All locales for which the exam should be generated
navigation	DiagnosticNavigation	The navigation settings for this exam
timing	Timing	The timing settings for this exam
feedback	Feedback	The feedback settings for this exam
question_groups	Array of QuestionGroup	The questions groups for this exam
numbas_settings	NumbasSettings	The settings to set for numbas
diagnostic	Diagnostic	The diagnostic data

DiagnosticNavigation

field	type	description
start_password	"none" or FileString	Password to begin the exam none and "" are the same
can_regenerate	Boolean	Whether the student can regenerate questions Old name was `allow_regenerate`
show_steps	Boolean	If false, then part steps will not be offered to the student, regardless of whether any have been defined in the exam’s questions Old name was `allow_steps`
show_title_page	Boolean	Whether the title page should be shown. Old name was `show_frontpage`
confirm_when_leaving	Boolean	Whether the student will be asked to confirm when leaving the exam.
show_names_of_question_groups	Boolean	Whether the names of the question groups should be shown.
allow_printing	Boolean	Whether the student is allowed to print the exam
on_leave	LeaveAction	Action to execute when a student changes question or tries to end the exam.

Diagnostic

field	type	description
script	DiagnosticScript	The script to use
objectives	Array of LearningObjective	The learning objectives,
topics	Array of LearningTopic	The learning topics

DiagnosticScript

One of the following items:

name	description
"mastery"	The aim of the Mastery algorithm is to repeatedly test topics until the student passes them. Once all topics are passed, the exam ends. see https://docs.numbas.org.uk/en/latest/exam/diagnostic.html#mastery
"diagnosys"	The aim of the DIAGNOSYS algorithm is to efficiently establish which topics the student understands, and which they don’t. see https://docs.numbas.org.uk/en/latest/exam/diagnostic.html#diagnosys
"custom"	A custom diagnostic script. See https://docs.numbas.org.uk/en/latest/exam/diagnostic.html#writing-a-diagnostic-algorithm

LearningObjective

field	type	description
name	Translation	The name of the learning objective
description	Translation	A description of the learning objective

LearningTopic

field	type	description
name	Translation	The name of the learning topic
description	Translation	A description of the learning topic
objectives	Array of Translation	List of names of objectives of which this topic consists
depends_on	Array of Translation	List of names of topics on which this topic depends

Rumbas