Structure of assignment

Ranke.2 has a layered structure, with teaching units containing both components and assignments.

While components are stored in the _units folder along with unit introductions, assignments must be stored in the _assignments folder to be correctly interpreted by Jekyll. Assignments can be grouped in folders named after the unit they belong to, like archival-digital-turn

Important: Make sure that the unit name matches the unit-id metadata of the unit.

naming convention for assignment file

As a general rule, assignments are markdown files: they must end with the .md. The file name should be composed of four parts separated by a point .

1. order, zero padded; e.g. 07
2. name, a-z lowercase letter, spaces substituted by a hyphen sign -; e.g. muybridge-legacy
3. language, 2 letters; e.g. en
4. extension .md

So, the first assignment for the unit archival-digital-turn with title Muybridge's legacy: from museum to the web will then become:

01.muybridge-legacy.en.md

assignment front matter

Super important. Property name must be in lowercase letter, a-z only;

property	value	required
layout	assignment	yes
lang	en OR fr	yes
unit	related unit_id	yes
title	free text	yes
requirements	free text	no
learning outcomes	list of sentences	no
order	integer*	no
cover	cover object tbd	no
tags	list of values	no

• if no order is given, file name order will be used.

---
layout: assignment
unit: archival-digital-turn
lang: en
title: "Muybridge's legacy: from museum to the web"
cover:
tags:
  - media history
  - web research
  - conversion from analogue to digital
requirements: Fast WIFI connection, scissors and paper
learning outcomes:
  - Understand *x*
  - Apply *y*
  - be able to do *z*
---

Structure of the markdown content

Right after the front matter, we established a rigid structure for the assignment content. The content is split using specific html comments:

A very Quick introduction.
<!-- more -->
// empty line left on purpose
<!-- briefing-student -->

    Section A, title
    <!-- section-contents -->
    Section A, content

    <!-- section -->
    
    Section B, title
    <!-- section-contents -->
     Section B, content

<!-- briefing-teacher -->
  Free text below, this completes the requirements and learning outcomes in the front matter.

Full assignment example:

---
layout: assignment
unit: archival-digital-turn
lang: en
title: "Muybridge's legacy: from museum to the web"
cover:
tags:
  - media history
  - web research
  - conversion from analogue to digital
requirements: Fast WIFI connection, scissors and paper
learning outcomes:
  - Understand *x*
  - Apply *y*
  - be able to do *z*

---

Edward Muybridge laid the basis for the development of cinematography.
This is a simple introduction.

<!-- more -->

<!-- briefing-student -->

    Section A, title
    <!-- section-contents -->
    Section A, content

    <!-- section -->
    
    Section B, title
    <!-- section-contents -->
    Section B, content

<!-- briefing-teacher -->
  
    Free text below, this completes the requirements and learning outcomes in the front matter.

Title levels for sections of the assignments

The title of the assignment corresponds to the title field of the yaml metadata of the assignment file. The title of each sub-assignment inside the file is of level 3:

### 1.c Applying Digital Source Criticism to Screenshots 

It is possible to define ids for these sections to obtain anchors. In this case, the above can be as follows:

### 1.c Applying Digital Source Criticism to Screenshots  {#dgs-to-screenshots}