Example Lesson

Episode with instructor notes

Overview

Teaching: 1 min
Exercises: 0 min
Questions

  • Can we combine longer texts for self-study with concise instructor notes for presentation?

Objectives

  • Add a toggle-switch to flip between two modes.

  • Create a lesson that has both full-length text and bullet-lists with talking points.

  • Some paragraphs, code and diagrams should remain visible in both modes.

Section 1

Some lessons are rather complex and require a lot of information.

This is a long text that describes a complex topic in detail. This contains information that the instructor explains in detail. However, large blocks of text make it difficult to use these pages instead of slides during a lesson or workshop as there is too much text for the attendees to read and for the instructor to pick out the talking points.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Some text should be visible in both modes.

$ echo "Code will stay the same"
graph LR A[Complex topic] -->|convert to| B(Lesson material) B --> C{How is
the material
used?} C -->|for self-study| D[present whole text
with links to further reading.] C -->|within workshop| E[present a short version
with bullet points]

Key Points

  • We can have custom elements to mark paragraphs as either ‘self_study_text’ or ‘instructor_notes’.

  • A toggle switch can switch between them.

  • Adding some additional CSS and JavaScript to the template will facilitate this feature.

Introduction

Overview

Teaching: 0 min
Exercises: 0 min
Questions

  • Key question (FIXME)

Objectives

  • First learning objective. (FIXME)

FIXME

Key Points

  • First key point. Brief Answer to questions. (FIXME)