Template Training

Structure of Episodes

Overview

  • Teaching: 15 min
  • Exercises: 0 min

Questions

  • What is the schedule?
  • Why does each episode need an overview?
  • How do I create my content?

Objectives

  • Understand why we adopt this structure
  • Be able to create content in the schedule and episodes

The Schedule

This is a special episode, typically 00_schedule.html, which gives an overview of the lesson, details any pre-requisites, links to each episode and any additional information such as setup required before starting the lesson. Prerequisites and Schedule are keywords that trigger decoration when the plain notebooks are built. This can be seen by comparing the plain and rendered schedule notebook.

This cell:

## Prerequisites
- Help students to know what they need to know before the course

renders to:

Prerequisites

  • Help students to know what they need to know before the course

While this cell:

## Schedule
Approximate timings for the lesson: (<-- strange bug dont remove line of text here ???)

| Time | Episode | Description |
|---|---|---|
| 0:00 | Coffee | Helps to kickstart the day |

renders to:

Schedule

Approximate timings for the lesson: (<-- strange bug dont remove line of text here ???)

Time Episode Description
0:00 Coffee Helps to kickstart the day

Typical Episodes

Apart from the schedule follow a standard format beginning with an ## Overview in which you can estimate the time for different activities, give examples of questions that the episode seeks to address and specify Learning Objectives. The end of the lesson has a ## Key points section which is used to recap stand out ideas from the lesson. As well as helping the teacher/trainer delivering the materil during workshops, adopting the practice of learning objectives, outcomes and recapping importance points can also help to develop focussed training materials and plan the scope of lessons from the early stages of development.

Your overview cell will look like:

## Overview
- **Teaching:** 5 min
- **Exercises:** 0 min

**Questions**
- What is the schedule?

**Objectives**
- Understand why we need objectives

and render to:

Overview

  • Teaching: 5 min
  • Exercises: 0 min

Questions

  • What is the schedule?

Objectives

  • Understand why we need objectives

While your key points:

## Key points
- Key points remind us to make sure we covered everything in our objectives!

renders to:

Key Points

  • KeyPoints remind us to make sure we covered everything in our objectives!

In between these two key sections you are free to set up cells, length and type as you choose. There are also additional key words that can be used to draw additional attention (Important: This is really important), and set up Exercises: A testing example and Solution: A testing example pairs. Further details on all the key words and what they do are given in the following the Features of the Build Exercise.

Key Points

  • A lesson requires a schedule and episodes.
  • The schedule gives an overview of the workshop and links each episode.
  • Each episode needs to be numbered and linked.
  • Keywords are used to decorate cells with pre-formatted html.

Previous

Schedule

Next