Adding quizzes

(Explain quizzes briefly)

Add a quiz resource

Start by adding a quizzes.hcl file, then add the following resources

resource "quiz" "quizzes" {
	questions = [
		resource.single_choice_question.capital_france,
		resource.multiple_choice_question.cities_france,
	]
	show_hints = true
}

resource "single_choice_question" "capital_france" {
	question = "What is the capital of France?"
	answer = "Paris"
	distractors = ["Lyon", "Nantes", "London", "Berlin"]

	hints = [
		"The correct answer is Paris .",
		"No, really, it's Paris ..",
		"Just pick Paris already ..."
	]
}

resource "multiple_choice_question" "cities_france" {
	question = "Which of these cities are in France?"
	answer = ["Paris", "Lyon", "Nantes"]
	distractors = ["London", "Berlin"]

	hints = [
		"One of these cities is in the UK",
		"Another city is in Germany"
	]
}

(Explain the resources, fields)

For more information and configuration on quizzes, please see the Quiz reference page.

Add a new page with activities

(Explain the activities block and what the fields mean)

resource "page" "quiz" {
  file = "instructions/quiz.md"

  activities = {
    "quizzes" = resource.quiz.quizzes
  }
}

resource "lab" "main" {
  ...
  content {
    ...
    chapter "introduction" {
      ...
      page "quiz" {
        reference = resource.page.quiz
      }
    }
  }
}

For more information and configuration on quizzes, please see the Page/activities reference page.

Embedding quizzes in your content

(Explain tasks, explain Instruqt Custom Component, especially )

Embed the quiz in your instructional content, create instructions/quiz.md and add the <instruqt-quiz> element so it looks like this

# Embedded quiz right here:

<instruqt-quiz id="quizzes"></instruqt-quiz>

Note that the id of the quiz must correspond to the resource name.

Preview your changes

(Guide, and screenshot of how our lab looks at this stage.)