Ths structure of a tutors course
A Tutors course is a folder of learning resources, named according to the conventions described in this manual.
| Example Resource | Display |
|---|---|
| reference-course | Reference Course |
The minimum requirements for a course are a folder containing these three files:
| File name | Purpose |
|---|---|
| course.md | Course title + general course information |
| course.png | Course image |
| properies.yaml | Course properties |
A markdown file, structured as follows:
Course Title
Course information - a course outline, description or any other information. Can be any length. Will appear as slide over if the user presses the Info button on the top left.
Course metadata in yaml format. At a minimum, this must contain the following:
credits: The course author(s) or organisation
The credits property will appear as a subtitle in the course title bar.
There are a range of other optional properties. See later in this documentfor a complete list of valid properties.
A course folder will typically contain topics (see below). Occasionally you may choose to place units directly in a course folder.
Courses typically contain topics, represented as folders with topic as the first 5 letters in the folder name. These topics can units (described below)
Top level learning resource for a course. Typically encapsulating a session or week of learning material.
| Example Resource | Display |
|---|---|
| topic-01-typical | Typical Topic |
Two files are required:
| Files | Purpose |
|---|---|
| topic.md | Topic title + summary. Any file name, file type must be .md file type |
| topic.png | Image for topic. File name must be same as .md file. File type can be .png, .jpg, or .jpeg |
The title and subtitle are extracted from the .md file, for example:
Simple
Units with presentations, labs + resources
In addition to the title, subtitle + image files specified above, the topic can contain any number of units (see below) or other learning resources.
A unit will encapsulate learning resources, framed by a title. Units can be within topics, or can appear directly in a course folder.
| Example Resource | Display |
|---|---|
| unit-1 | Main Lesson |
One .md file is required:
| Files | Purpose |
|---|---|
| unit.md | Title for the unit. The file can have any suitable name, but must be .md file type |
The title is specified in a single markdown file:
Main Lesson
Units contain any number of learning resources.
A side will encapsulate learning resources, framed by a title. It is equivalent to a Unit (see above), but framed within a side bar.
| Example Resource | Display |
|---|---|
| side-unit | Labs for this Topic |
On .md file is required:
| File name | Purpose |
|---|---|
| side.md | Title for the side bar. The file can have any suitable name, but must be .md file type |
The title is specified in in this file:
Labs for this Topic
Side bar can contain any number of learning resources.
There are 2 broad types of learning resources
Typically card or panel learning resources are child folders within topic, unit or side folders.