-
-
Notifications
You must be signed in to change notification settings - Fork 23
Describe how we intend callouts to be used? #257
Copy link
Copy link
Closed
Labels
type:discussionDiscussion or feedback about the lessonDiscussion or feedback about the lessontype:formattingFormatting needs to be fixedFormatting needs to be fixedtype:instructor guideIssue with the instructor guideIssue with the instructor guide
Milestone
Metadata
Metadata
Assignees
Labels
type:discussionDiscussion or feedback about the lessonDiscussion or feedback about the lessontype:formattingFormatting needs to be fixedFormatting needs to be fixedtype:instructor guideIssue with the instructor guideIssue with the instructor guide
While prepping #256, I was reflecting on how we are using callouts for optional material that could be covered at the Trainers' discretion/to pre-empt questions from trainees. Furthermore, the number of callouts in the curriculum is getting quite large (16 at time of writing) so could translate to a large difference in total teaching time if all were covered in full.
However, there is real variation in how callouts are used across lessons: some lessons seem to use them to highlight something particularly important, to encourage Instructors to emphasise this content. Which is pretty much the exact opposite of how we are using them! 😆
If we are going to keep using callouts this way, I think it would be sensible to add something to the Instructor Notes page to explain our intention.
The alternative, when the spoiler class of fenced div is introduced in the next release of
sandpaper, would be to replace these callouts with expandable/collapsible spoilers. That would save some space on the page and would have the advantage of visually implying the optional nature of the content they contain.What do you think @sstevens2 @mkuzak @anenadic?