Episode template
Questions
What syntax is used to make a lesson?
How do you structure a lesson effectively for teaching?
questionsare at the top of a lesson and provide a starting point for what you might learn. It is usually a bulleted list.
Objectives
Show a complete lesson page with all of the most common structures.
…
This is also a holdover from the carpentries-style. It could usually be left off.
The introduction should be a high level overview of what is on the page and why it is interesting. This page demonstrates every element you might typically find in a lesson and their typical usage.
The lines below (only visible in the source file) will set the default highlighting language for the entire page.
Section
A section.
Discussion
Discuss the following. This is green, so is intended to be exercise-like (active work in the class).
A discussion section
Another discussion topic
Section
print("hello world")
# This uses the default highlighting language
print("hello world)
This is a group-tab (if you flip it, all tabs on the page flip to this)
print("Hello World!")
Exercises: description
Exercise Topic-1: imperative description of exercise
Exercise text here.
Solution
Solution text here
The following code-tab has each tab as a code block (there is no space for unformatted text).
print("Hello World!")
# Note the tab titles need to be lowercase to max the exact lexer names.
print("Hello World!")
Advanced: topic of the box
Include advanced material in a box such as this. Depending on the importance, it could be dropdown, or not.
The purpose of setting it off like this is to make it clear that one does not need to focus their mental effort on this during the main lesson, but an instructor could of course choose to talk about it during any particular teaching event.
Optional: topic of the box
Include optional material in a box such as this. Depending on the importance, it could be dropdown, or not.
Image
Detailed caption goes here. When creating images, you should consider how other people coming after you can modify them. Include a modifiable source, and consider what is common enough that other people will know how to maintain it in the future. Also consider making it not so specific to the current text, so that it doesn’t have to be updated for every text change (maintainable is better than perfect). Consider using the caption for changeable explanations, instead of embedding it in the image. (Source: machine generated random image, CC-0)
Include alt text with the basics, but don’t duplicate explanation from the text in the caption (instead say “as explained in text”).
You should ONLY include CC-BY 4.0 or public domain images. Include the attribution in the image caption here.
Summary
A Summary of what you learned and why it might be useful. Maybe a hint of what comes in the next lesson.
See also
Other relevant links
Other link
Keypoints
What the learner should take away
point 2
…
This is another holdover from the carpentries style. This perhaps is better done in the “summary” section.