Forschen

Schnell Präsentationen erstellen mit Markdown, Pandoc und Beamer

Innerhalb weniger Minuten eine perfekt formatierte Präsentation zu erstellen mag vielen unmöglich erscheinen, ist aber einfacher als man es sich vorstellt.

Wir verwenden dafür die Auszeichnungssprache (engl.: markup language) Markdown und Pandoc ein Programm zur Konvertierung bei dem im Hintergrund LaTeX und dessen Erweiterung Beamer laufen. Pandoc wandelt dabei blanken Text in ansehnliche PDF Dateien um.


Was sind Vorteile Präsentationen auf diese Weise zu erstellen?

Ein Leerzeichen zu viel und schon sitzen andere Elemente nicht mehr an der richtigen Stelle. Dadurch, dass bei unserer Arbeitsweise Markdown und LaTeX benutzt werden, können Objekte fest an Positionen verankert werden. Diese ändert sich nicht solange man dies nicht selber in den Parametern ändert.

Das gemeinsame Arbeiten an einer Präsentation wird vereinfacht. In Kombination mit Diensten wie Gitlab, bekommt man dazu noch dessen typische Vorteile wie z. B. Möglichkeiten zur Automatisierung, Versionsverwaltung und einen Cloud Speicher.

“Ich kann doch einfach meine Präsentationsdatei von Programm XY in ein Git hochladen!” Diese Möglichkeit besteht durchaus, jedoch kann man die Unterschiede nach der letzten Bearbeitung nicht gut erkennen. Bei einer Änderung von Markdown Dateien und der Nutzung von git diff, lassen sich Änderungen zwischen Commits angenehm anzeigen.

Dienste wie Gitlab können auch die Fehler-Kontrolle verbessern. Die Veränderungen von verschiedenen Nutzern können durch Nutzung von Pull Requests kontrolliert werden und das vor Übernahme in den Main Branch.

Durch Optionen wie Kommentare kann man sich schnell Notizen zu Informationen aufschreiben, die nicht in der Präsentation zu sehen sind.

Man ist nicht nur auf Markdown angewiesen. Zwar besitzt Markdown eine sehr einfach zu lernende Syntax, jedoch funktioniert Pandoc ebenso mit reinem LaTeX, sowie HTML. Zudem kann man Befehle aus diesen Sprachen gemischt einsetzen.

Weiterhin sind alle Optionen von reinem LaTeX nutzbar, wie zum Beispiel mathematische Formeln und viele Arten von Diagrammen. Auch Inhaltsverzeichnisse können generiert werden.

Kleinere Datei Größe und keine Abhängigkeit von Office Programmen, nehmen ebenso einen großen Stellenwert ein. Dies wird gewährleistet, da blanke PDF-Dateien benutzt werden. Daraus folgen keine nervenaufreibenden Abstürze von Word, etc.

Aus der vorhandenen Markdown Datei kann nebenbei auch ein normales PDF Dokument erstellt werden. Dadurch wird die Zeit zum Ausarbeiten einer eventuell ebenso geforderten Dokumentation gespart.


Nachteile dieser Präsentationsart

Dadurch, dass wir hier mit PDF Dateien arbeiten, ist man etwas beschränkter in seinen Möglichkeiten. Animationen sind nur über Umwege möglich, und selbst dann bleiben sie schlicht.

Zudem bietet LaTeX viele Möglichkeiten Dokumente zu gestalten, ohne dass diese grafisch in einem Editor dargestellt werden. Die große Menge an Möglichkeiten ist dabei auf den ersten Blick erdrückend. Aber einmal erstellt muss man sich keine Gedanken mehr über das Design machen.



So geht’s - Schnell Präsentationen erstellen mit Markdown, Pandoc und Beamer

Ein Markdown Text kann dabei so aussehen:

Pandoc wandelt diesen Text in wenigen Sekunden in folgendes um:



Wie funktioniert die Konvertierung?

Um die Funktion Pandocs zu gewährleisten läuft im Hintergrund eine LaTeX Version. Welche LaTeX Version genau verwendet werden muss hängt hierbei von Nutzer Präferenzen, sowie des Betriebssystems ab. Das Gute hierbei ist, dass LaTeX sowohl unter Linux, Windows und auch MacOS genutzt werden kann.

Pandoc baut zunächst aus der Markdown Datei ein LaTeX Dokument und dieses wird dann in eine PDF-Datei umgewandelt. Um Eigenschaften einer Präsentation zu erhalten benutzen wir hier eine LaTeX Erweiterung namens Beamer. Beamer nimmt hier aber keine Änderungen des Dateityps vor. Es bleibt eine PDF-Datei.


Wie erstelle ich eine Präsentation?

Pandoc kann bei der Konvertierung von Markdown Dateien auch mit festgesetzten Attributen arbeiten. Dafür erstellt man einen Header im YAML Format. In diesem Header werden unter anderem Daten wie zum Beispiel Titel, Autor, Datum, etc. festgelegt. Ebenso kann man das Design der Präsentation festlegen. Die Beamer Klasse bietet dafür auch ein paar vorgefertigte Lösungen.

Danach setzt man sein Dokument in herkömmlicher Markdown Syntax fort.

Um das Dokument in eine PDF zu konvertieren kann man (unter Linux) folgende Befehle nutzen.

pandoc gonicus.md -t beamer -o result.pdf
pandoc gonicus.md --from markdown --to beamer --output result.pdf

Pandoc kann Probleme bekommen, das Beamer Template durch den YAML-Header zu laden. In dem Fall lädt man das Template direkt im Pandoc Befehl:

pandoc gonicus.md --from markdown --to beamer \ 
--include-in-header=./beamerthemegonicus.sty --output result.pdf


Wie personalisiere ich meine Präsentation?

Um ein eigenes Design zu erstellen benötigt man Kenntnisse in LaTeX und und der LaTeX Klasse Beamer. Beamer stellt viele Objekte zur Verfügung, welche unterschiedlich angeordnet werden können um eine ansehnliche Präsentation zu erstellen.

Man erstellt dafür zum Beispiel eine “beamerthemegonicus.sty” Datei in der alle Befehle, die das Design betreffen, liegen. Durch diese Namens Konvention kann man in dem YAML-Header die Kurzform referenzieren:

Je mehr Optionen möglich sein sollen, desto mehr bietet es sich an die “beamerthemegonicus.sty” in mehrere Dateien aufzuteilen um einen besseren Überblick behalten zu können, bzw. die einzelnen Sub-Designs einzeln wechseln zu können. Dabei ist folgende Aufspaltung möglich:

  • beamerthemegonicus.sty
  • beamerouterthemegonicus.sty
  • beamerinnerthemegonicus.sty
  • beamercolorthemegonicus.sty
  • beamerfontthemegonicus.sty

Hierbei wird das “beamerthemegonicus.sty” lediglich noch benutzt um die Sub-Designs zu laden und eventuell die von den Designs benötigten LaTeX Klassen zu importieren.

In dem “beamerouterthemegonicus.sty” werden in dem Fall die meisten Designelemente festgelegt. Dabei gibt es direkt Funktionen für die Titelfolie, Folientitel, Fußzeilen, etc. .

Das “beamerinnerthemegonicus.sty” betrifft hauptsächlich den Inhalt der Folien und dessen Formatierungen (beispielsweise das Aussehen von Spiegelstrichen)

Für die farbliche Gestaltung hält das “beamercolorthemegonicus.sty” her und alles im Bereich Strift übernimmt das “beamerfontthemegonicus.sty”.

“Mein Office Programm hat aber Rechtschreibprüfung”

Der Vorteil, dass man nicht auf ein Office Programm angewiesen ist bringt gleichzeitig ein paar Nachteile. Privilegien wie Rechtschreibprüfung bleiben einfachen Editoren wie gedit, kwrite und dem Microsoft Editor fern. Jedoch finden sich Editoren wie Visual Studio Code, die Lösungen dafür bieten. VS Code besitzt dutzende Erweiterungen, welche bei der Arbeit unterstützen. Die gewollte Rechtschreibprüfung ist hierdurch auch Nutzbar.

Warum sollte ich Präsentationen auf diese Weise erstellen?

Auch wenn es viel Aufwand bedeutet das Personalisieren der Beamer Präsentationen zu erlernen, nimmt diese Arbeitsweise einiges an Arbeit ab. Der Mehraufwand durch plötzliche Formatierungsfehler von Office-Programmen wird hierbei umgangen. Dadurch, dass Markdown Dateien konvertiert werden, lässt sich der Text einfach in unterschiedliche Formate übertragen. Bei wiederkehrenden Designs betreibt man im besten Fall nur ein mal einen größeren Aufwand und spart sich im Endeffekt viel Zeit.

Warum verwendet GONICUS diese Methode?

Unsere Kolleginnen und Kollegen sind es gewohnt mit Markdown zu arbeiten. In den Editoren fühlen sie sich Zuhause und hier können sie sich rein auf den Inhalt konzentrieren. Zusätzliche Punkte wie Positionierungen, Schriftgrößen, Headlines oder Sublines werden hier durch einfache Befehle mitgeschrieben oder sind im Layout bereits fest verankert. So steigern wir die Qualität des Inhalts bei einem gleichbleibenden Design mit viel Übersichtlichkeit und Wiedererkennungswerten.



Fußnoten

LaTeX

Die Software LaTeX ist vor allem im Raume des wissenschaftlichen Arbeitens bekannt. Sie arbeitet mit dem WYSIWM Prinzip (What you see is what you mean) statt Editoren wie Microsoft Word mit dem WYSIWYG (what you see is what you get). Der Vorteil davon ist, dass man Positionen durch Befehle fest definiert und diese sich nicht verändern, solange man nicht selber dafür sorgt. Dadurch kann man mit LaTeX Formatierungsarbeiten zuverlässig erledigen.

×
×

Nehmen Sie Kontakt zu uns auf!

Mit * gekennzeichnete Felder sind Pflichtfelder.

Wir haben Ihre Kontaktanfrage erhalten und melden uns kurzfristig bei Ihnen!

×

Ich möchte eine Frage einreichen!

Vielen Dank für das Einreichen Ihrer Frage!