Workbench Component Guide
Last updated on 2024-12-03 | Edit this page
Find out More!
This is the component guide for the workbench. For details on how to create components from fenced divs, read the Callout Blocks section of “Episode Structure”.
Required Sections
The workbench requires objectives and
questions at the beginning and keypoints at
the end of each episode.
Overview
Questions
QUESTIONS callouts are created with the questions tag
and offer questions for the learner before they start the episode.
Objectives
OBJECTIVES callouts are created with the objectives tag
and outline what the learners should take away from the episode.
KEYPOINTS (keypoints)
KEYPOINTS callouts are created with the keypoints tag
and offer key takeaways from the episode to summarise what the learners
should have learned.
Instructor Notes
Special sections that only appear on the instructor view (use the button at the top right of the page to toggle).
Callout Blocks
Sections to pause the narrative flow of an episode for learners to reflect.
CALLOUT (callout)
CALLOUT callouts are created with the callout tag and
are an aside or comment.
CAUTION (caution)
CAUTION callouts are created with the caution tag and
raise awareness of potential issues or problems that a learner might
experience.
PREREQUISITES (prereq)
PREREQUISITES callouts are created with the prereq tag
and indicate things a learner needs before starting the episodes
(e.g. data from a previous episode or and understanding of a particular
concept).
CHECKLIST (checklist)
CHECKLIST callouts are created with the checklist tag
and are a way to more strongly emphasise particular steps.
CHALLENGE (challenge)
CHALLENGE callouts are created with the challenge tag
and represent formative assessment opportunities for the learners to
practice their skills.
HINT accordions are created with the hint tag and nested
within challenge callouts. These offer more context for the
challenge that can help the learner find the solution.
SOLUTION accordions are created with the solution tag
and nested within challenge callouts. These provide the
learners with the solution to the challenge so they can confirm their
answers.
DISCUSSION (discussion)
DISCUSSION callouts are created with the discussion tag
and represent an open-ended formative assessment in which the learners
are expected to discuss a particular topic with other learners.
TESTIMONIAL (testimonial)
TESTIMONIAL callouts are created with the testimonial
tag and are quotations from previous learners or instructors.
SPOILER callouts are created with the spoiler tag and
are a way to provide additional details/content that can be expanded and
collapsed on demand.