Les fiches des cours

Les fiches des cours

Les cours sont de simples fichiers de texte. Le nom des fichiers devra se terminer par .md (md signifie "Markdown").

Formatage du contenu

Pour obtenir certains éléments de mise en page – comme des titres, des listes à puce, des images, des liens – on utilise le langage Markdown. Voici plus d'infos sur la syntaxe markdown.

Organisation par dossiers

Vous pouvez mettre les cours dans des dossiers, ou les laisser au premier niveau. Choisissez ce qui est le mieux pour votre organisation, cela n'a pas d'influence sur le fonctionnement du site.

Vous pouvez également les ranger dans plusieurs dossiers pour différencier des types de cours (par exemple: EP, AP, cours de théorie, de pratique...) en fonction de la structure de votre programme. Ces dossiers servent à votre confort mais n'affectent pas la logique du site. Pour différencier, utiliser les métadonnées (voir ci-dessous).

Le bloc de métadonnées

Vous pouvez définir un en-tête contenant des métadonnées. Il s'agit d'un bloc délimité par des doubles tirets: "--". Un exemple:

---
title: Défense contre les forces du Mal
layout: cours
type: EP
code: EPINF
periodes: 40
cursus:
  - Dual: S1
  - Plein-temps: S2
competences:
  - 2.1.1: 20
  - 2.1.2: 10
  - 2.1.3: 10
  - 3.7.3: 10
profs:
  - Quirinus Quirrell
  - Severus Rogue
---

Les indispensables

Cet exemple contient un grand nombre de métadonnées, elles ne sont pas toutes obligatoires. Les seules qui sont nécessaires pour le bon fonctionnement sont:

• title: Indique le titre à afficher (si non rempli, utilise la première balise H1 du contenu).
• layout: Spécifie le modèle de page à utiliser. Il est important d'indiquer: cours.

Autres métadonnées

Les autres données sont facultatives. Leur utilité:

• type: permet de classer les cours, et de les afficher par listes (voir: Modèle de page-liste).
• code: permet d'indiquer un acronyme, une abréviation.
• periodes: nombre de périodes semestrielles. Certains modèles de page les additionneront pour indiquer le total de périodes du semestre.
• cursus: indique à quel moment du cursus le cours aura lieu. Dans cet exemple on a deux voies (Dual, Plein-temps) qui auront ce cours à des semestres différents. Les unités peuvent être indiquées librement en semestres (S1,S2...), semaines, jours (Lundi, Mardi...). Elles devront correspondre aux unités qui figurent dans la page Cursus.
• timeunit: permet de définir un terme autre que "Semestre" (p.ex. Jour, Semaine, Année).
• competences: permet de se référer à une liste de compétences opérationnelles propres à la formation.
• profs: permet d'indiquer les noms d'enseignant·es pouvant donner ce cours.

Il existe aussi des métadonnées "standard" de Jekyll (voir documentation Jekyll):

• permalink: permet d'indiquer une URL différente de celle générée automatiquement à partir du nom de fichier.
• published: en mettant "false", la page ne sera pas publiée sur le site.

Afficher un cours à plusieurs semestres

Une même fiche de cours doit apparaître à plusieurs semestres, par exemple en S1 et S2? Dans ce cas il faut écrire le champ cursus de cette manière:

  - Dual: S1
  - Dual: S2