Sebastian Lukas Hauer
Lehrstuhl für Computergraphik, TU Dortmund
Das Programm decker
müssen Sie in einem Projektverzeichnis ausführen.
decker
akzeptiert ein Verzeichnis in ihrem System als ein Projektverzeichnis, wenn es eine Datei mit dem Namen decker.yaml
beinhaltet.
In der Datei decker.yaml
wird Ihr Projekt konfiguriert.
Wird das Programm decker
in einem Projektverzeichnis ausgeführt generiert es aus Ihren Markdownquelldateien eine Sammlung von Webseiten in denen Ihre Präsentationen vorliegen.
Wenn Sie decker
über die Kommandozeile aufrufen werden diese Operationen über Kommandozeilenparameter bestimmt.
Die wichtigsten Operationen sind im Visual Studio Code Plugin decker server
als Rechtsklickoptionen im Kontextmenu der Dateiübersicht verfügbar.
Die Standardfunktionalität von decker
übersetzt alle -deck.md
und -page.md
Dateien in ihre entsprechenden -deck.html
-Foliensätze und -page.html
-Webseiten.
Diese Operation kann durch den Aufruf von decker
oder decker html
ausgeführt werden.
Im Kontextmenu von VS-Code finden Sie diese Operation unter “Decker …” > “Projekt bauen”.
Sie können decker
befehlen ausschließlich -deck.md
-Foliensätze zu übersezten.
Diese Operation kann durch den Aufruf von decker decks
ausgeführt werden.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Nur Foliensätze generieren
.
Sie können decker
befehlen ausschließlich -page.md
-Webseiten zu übersezten.
Diese Operation kann durch den Aufruf von decker pages
ausgeführt werden.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Nur Webseiten generieren
.
Aus -deck.md
-Foliensätzen können zusätzlich auch Handout-Webseiten generiert werden, die alle textuellen und die meisten medialen Inhalte beinhalten. Interaktive Inhalte, wie z.B. Quizzes und andere Funktionalitäten, die insbesondere durch die Präsentationsbibliothek Reveal.js
umgesetzt werden, sind in den Handouts jedoch nicht interaktiv, sondern werden maximal als wie im Quellcode angegebene Inhalte wie Checklisten angezeigt.
Diese Operation kann durch den Aufruf von decker handouts
ausgeführt werden.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Handouts bauen
.
Unter Linux und MacOS können Sie die Druckversion aller Foliensätze automatisiert generieren lassen.
Decker verwendet für diese Operation den auf Ihrem System installierten Google Chrome-Browser.
Unter Windows funktioniert das automatisierte Drucken einer Webseite mithilfe von Google Chrome nicht.
Diese Operation kann durch den Aufruf von decker pdf
ausgeführt werden.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> PDFs generieren
.
Sie können den Ausgabeordner public
, der von decker
beim Übersetzen von Dateien angelegt wird jederzeit manuell löschen.
Sie können das Programm decker
dazu anweisen dies für sie zu tun, indem Sie es mit decker clean
aufrufen.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Verzeichnis aufräumen
.
Sie können decker
dazu auffordern ihr Projektverzeichnis zu beobachten und bei Änderungen an Dateien die betroffenen Foliensätze oder Webseiten automatisch neu zu übersetzen.
Diese Funktion können Sie mit decker watch
initialisieren. Das Programm müssen Sie nachträglich mit der Tastenkombination STRG + C
abbrechen, da es nicht von selbst terminiert.
Sie können decker
anweisen einen lokalen Webserver zu starten, der die Foliensätze und Webseiten ausliefert. Dieser Mechanismus sorgt bei initialem Aufruf auch für eine Übersetzung der Materialien. Zudem werden die Dateien im Projektverzeichnis wie beim Aufruf von decker watch
beobachtet und bei Änderungen neu übersetzt.
Das Starten des Webservers wird mit dem Aufruf decker --server
oder decker -S
umgesetzt.
Werden Materialien neu übersetzt stößt zudem der Webserver ein Neuladen der betrachteten Foliensätze und Webseiten im Browser an.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Server starten
oder durch einen Klick auf die Informationskachel “No Decker Server running in this session” in der Statuszeile des Editors.
Zusätzlich zum public
-Verzeichnis erzeugt decker
auch einen - unter Linux und MacOS versteckten - Ordner namens .decker
in Ihrem Projektverzeichnis. In diesem Ordner werden Metadaten abgelegt, die bei der Übersetzung Ihrer Foliensätze oder Webseiten notwendig sind.
Sie können zusätzlich zum public
-Verzeichnis auch diesen Zwischenspeicher löschen, indem Sie decker purge
aufrufen und somit alle von decker
generierten Dateien aus ihrem Projektverzeichnis zu löschen und dieses damit vollständig bereinigen.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Verzeichnis vollständig bereinigen
.
Sie können in Ihrer Projektkonfiguration einen Zielrechner und -ort angeben, zu dem Decker mithilfe des Programms rsync
eine Verbindung aufbauen und das generierte public
Verzeichnis kopieren soll.
Sie können decker
dazu anweisen diese Synchronisation mit einem Zielrechner durchzuführen, indem sie es mit decker publish
aufrufen.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Projekt veröffentlichen
.
Eine Erklärung der Konfigurationsoptionen für diesen Befehl finden Sie hier.
Nachdem Sie Foliensatz und Webseitendateien mit decker
übersetzt haben können Sie mithilfe der Funktion decker search-index
einen Suchindex erstellen. Dieser wird in ihrem public
-Verzeichnis hinterlegt und kann genutzt werden, um eine Suche durch das gesamte Projekt zu ermöglichen.
Sie müssen zur Verwendung des Suchindexes folgenden Quellcodeschnipsel in ihrer Indexseite verwenden:
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Suchindex generieren
.
Die Videos, die Sie während einer Präsentation aufnehmen werden als .webm
-Dateien gespeichert. Dieses Dateiformat eignet sich zum Ausliefern und Abspielen von Videos im Internet nicht so gut wie .mp4
. Zudem erlaubt decker
die Aufnahme von Vorträgen in Teilen. Diese müssen nachträglich in ein Video zusammengeführt werden.
Für diesen Mechanismus verwendet decker
das von Ihnen zu installierende Programm ffmpeg
.
Sie können decker
zum Konvertieren aller Videos in Ihrem Projektverzeichnis in entsprechende .mp4
-Dateien mit dem Befehl decker crunch
anweisen.
Im Kontextmenu von VS-Code finden Sie diese Operation unter Decker ...
> Videos komprimieren
.