YAML-Block

YAML-Block einer Markdown-Datei

Eine Markdown-Datei kann mit folgendem Code beginnen. Dessen Inhalt wird als YAML-Parameter von mdmachine als auch von pandoc ausgewertet:

---
title: "Mein Werk"
m²_generate_slides: True
...

Parameter, die auch von pandoc genutzt werden

title

Wird von mdmachine notfalls aus dem Dateinamen erzeugt. Bevorzugt sollte dies der Autor aber angeben.

Weitere sind z.B. subtitle, date, abstract, abstract-title, description, lang usw.
Diese Parameter erkennt man daran, dass es englische Begriffe sind.
Die Parameter exclusiv von mdmachine beginnen hingegen immer mit “m²_”.

Parameter zur Slide-Generierung

m²_generate_slides

{yes | no | keep}
Bei keep wie yes, aber die HTML-Datei für die Slides wird für Debugzwecke nicht gelöscht.

Ohne diesen Parameter werden keine Slides erzeugt.

m²_suppress_pdf

{yes | no}
Es wird ggf. garkeine PDF-Datei erzeugt.

Ohne diesen Parameter wird immer die Din-A4-PDF-Version erzeugt.

m²_slide_format

{ beamer | fhd | gen8 | a5 }
Liefert das Wunschformat für die Präsentations-Slides.

Ohne diesen Parameter wird bei m²_generate_slides immer a5 erzeugt.
Man kann mehrere Formate als Array angeben: m²_slide_format: [a5,fhd]

Die Folienhöhe ist immer 14,5 cm. Die Breite wird hier für bestimmte Seitenverhältnisse verändert:

beamer: für z.B. 1280x800 und damit 16:10
fhd: für FullHD und HDready (1280x720) und damit 16:9
gen8: für ältere iPads den Generation 8
a5: für iPad Air 5. Generation bzw. ungefähr Din-A5 quer.

Summendokument

m²_include_after

Dateinamen. Die Inhalte der genannten Dateien werden an die aktuelle Datei angehängt. Dabei wird deren YAML-Block ignoriert, so dass auch keine Rekursion möglich ist.
Verwendung z.B. für Kolloquiumsprüfungen mit individueller Titelseite und einer angehängten Auswahl von Aufgaben-Dateien.
Tipp: der Name der anzuhängenden Datei kann mit einem Unterstrich beginnen, um nie selbst in HTML konvertiert zu werden.

Für die Einstufung im Verzeichnis

m²_sbpriority

{ high | low }
Priorität, der für die Anordnung dieser Datei in der sidebar entscheidend ist.
In der Dateiliste führen die Dateien mit Prio high (Fettdruck), gefolgt von den normalen und schließlich die mit low (Dünndruck). Innerhalb ihrer Kategorie wird immer alphabetisch nach dem Titel sortiert.

Ohne diesen Parameter wird prio normal angenommen.