In einem unserer letzten tub.torials-Beiträge ging es um das Schreiben mit Markdown. An unterschiedlichen Stellen haben wir auf den Markdown-Editor Zettlr hingewiesen, dem wir uns nun in diesem Beitrag widmen. Zettlr ist eine Open-Source-Anwendung, die das Schreiben von Markdown-Texten ermöglicht und dabei einige hilfreiche Features wie den Im- und Export von Dateien sowie die Verknüpfung mit eigenen Literaturquellen ermöglicht. Bei der Vorstellung handelt es sich um eine bearbeitete Fassung unserer Kalendertürchen 05 und 15 aus dem Open-Access-Adventskalender.

Zettlr – Vorstellung und Installation

In diesem Beitrag werden wir unter anderem zeigen:

• Was genau ist eigentlich Zettlr?;
• Zu installierende Komponenten;
• Einstellungen und Funktionen von Zettlr;
• Import und Export von Dateien;
• Literaturquelleneinbindung.

Was genau ist Zettlr?

Markdown-Editoren und andere Schreibumgebungen gibt es einige. Als Beispiele seien an dieser Stelle WriteMD (TU-Instanz von HackmD, die bei uns vor allem als kollaborative Online-Schreibumgebung und zur Erstellung von Lernskripten und Protokollen genutzt wird), Typora und VSCodium genannt. Das „Problem“ oder eher die Herausforderung für potentielle Nutzer:Innen ist bei vielen Editoren die oftmals vor allem für Coder:innen gestaltete Oberfläche. Diese kann gerade für Interessierte ohne Code-Affinität oder mit jahrelangen Schreiberfahrungen in gängigen What-You-See-Is-What-You-Get-Schreibanwendungen (WYSIWYG) wenig einladend bis erschreckend wirken.

Und hier kommt Zettlr ins Spiel. Der Markdown-Editor kann potentiell Word- und andere Schreibanwendungen ersetzen und richtet sich mit seiner aufgeräumten grafischen Oberfläche an Nicht-Coder:innen (und natürlich auch Coder:innen). Vor allem beim Verfassen wissenschaftlicher Texte mit Literaturquellen sticht Zettlr heraus.

Zettlr fokussiert sich mit seiner aufgeräumten Oberfläche auf das Schreiben und Lesen.

Erschaffen wurde die Open-Source-Anwendung von Hendrik Erz, der es nach viel Frust mit gängigen Wordprozessoren selbst in die Hand nahm, eine Schreibumgebung zu schaffen, die sich vor allen auf das Schreiben und Lesen fokussiert. Dabei bietet sie einen Mittelweg aus sehr techniklastigen und benutzerfreundlichen Anwendungen, unter anderem:

• Schreibstatistiken;
• Einstellungsoptionen zur Zielsetzung der Wortanzahl;
• eine Volltextsuche;
• eine Markdown-Vorschau;
• die Möglichkeit für den Import und die Zitation von Quellen aus einer eigenen Zotero-Datenbank;
• Export der Markdowndatei auf Mausklick in Formate wie HTML, PDF, ODT oder DOC.

Zettlr funktioniert zudem unabhängig vom Betriebsystem. Ein großer Vorteil, denn so können sowohl Windows-, als auch Mac- und Linux-Nutzer:innen Zettlr verwenden. Selbst für den Einsatz des Zettelkastensystems, einem Hilfsmittel zum Festhalten von Ideen und Gedanken, ist die Anwendung (inklusive einer umfassenden Dokumentation) ausgestattet. Einen Einblick in diese Funktion gibt auch der tub.torials-Gastbeitrag Geschichte und Gegenwart meiner Notizen von Benjamin Roers. Weitere Funktionen von Zettlr lassen sich hier einsehen.

Zettlr wird von uns in verschiedenen Kontexten im Arbeitsalltag genutzt. Als Beispiel seien die Dokumention von Arbeitsabläufen, das Verfassen von Tagungsberichten und generell Fließtexte mit Literaturverweisen genannt.
Im Rahmen unseres Projektes „Modernes Publizieren“ nutzen wir Zettlr unter anderem zudem für die Aufbereitung von wissenschaftlichen Beiträgen, die wir für die Neuveröffentlichung des Journals kommunikation@gesellschaft aus dem DOCX-Format in Markdown-Dateien konvertiert haben, um so die Grundlage für offenes Publizieren und Open Science zu schaffen.

Zettlr installieren

Die einfachste Möglichkeit zur Zettlr-Installation ist die Nutzung des Installationspakets, das auf der offiziellen Zettlr-Webseite angeboten wird.

Nach Anstoßen des Installationsvorgangs muss nur noch den Bildschirmanweisungen gefolgt werden. Die Installationsbeschreibung für andere Betriebssysteme wie Windows und Linux kann in der offiziellen Dokumentation von Zettlr eingesehen werden.

In der offiziellen Installationsdokumentation können die unterschiedlichen Installationsmöglichkeiten eingesehen werden.

Wenn wir Texte ohne Verknüpfung zu Literaturquellen (bspw. Zotero-Datenbanken) schreiben wollen, so sind nach der Installation von Zettlr keine weiteren Schritte nötig. Für den Dateiexport und die Verknüfung und Nutzung unserer Literaturquellen sind jedoch noch zwei weitere Anwendungen zu installieren: Pandoc und LaTeX.

Pandoc installieren und einrichten

Pandoc ist ein Multidokumentenparser, der die Konvertierung in andere Formate ermöglicht. Pandoc selbst wird in der Regel auf Kommandozeilenebene verwendet. Dank der Exportfunktion von Zettlr bekommen wir davon nach der Installation jedoch nichts mit: Dateiim- und -exporte werden auf Mausklick angestoßen. Pandoc ist quelloffen und kann über die Installationshilfe von Zettlr installiert werden. Dazu gehen wir auf den Menüpunkt „Hilfe“ und wählen „Pandoc installieren“.

Damit Zettlr Dateikonvertierungen durchführen kann ist die Pandoc-Installation erforderlich.

Wir werden zu Github weitergeleitet – einem netzbasierten Dienst zur Versionsverwaltung von Software – wo wir die aktuelle Pandoc-Version für unser benötigtes Betriebssystem runterladen können.

Zur Überprüfung klicken wir in Zettlr auf das Icon mit dem Blatt und dem Pfeil („Exportieren“) am oberen Bildschirmrand und wählen ein Export-Format aus, das wir mit einem weiteren Klick generieren:

Der Export wird nun per Klick ausführbar.

Weiter geht es mit der Installation von LaTeX.

LaTeX installieren

LaTeX ist ein Textsatzsystem, das Anwender:innen durch Einsatz von Code viele Strukturierungsmöglichkeiten und Unterstützung bei der Leistungsverwaltung bietet. Wenn wir also nicht nur einfachste Texte exportieren, sondern zum Beispiel auch PDF-Dateien erzeugen wollen, so brauchen wir LaTeX. Wie bei Pandoc ist auch LaTeX quelloffene Software. Für die Installation gehen wir – wie bei Pandoc – auf den Menüpunkt „Hilfe“ am oberen Bildschirmrand und wählen hier „LaTeX installieren“ aus. Wir werden auf die Seite des LaTeX-Projektes weitergeleitet, wo wir uns für unsere Systemsoftware entscheiden. Weitere Informationen zur Installation von LaTeX gibt es auch in der offiziellen Dokumentation von Zettlr.

Haben wir die Installation von LaTeX durchgeführt, so ist fortan auch die Generierung von PDF-Dateien möglich.

Auch der PDF-Export gelingt mit einem Klick.

Einstellungen und Nutzung

Nachdem wir Zettlr kennengelernt haben und einen Blick auf die Installation geworfen haben, wollen wir nun einige Einstellungen und die Nutzung selbst betrachten. Die folgenden Screenshots entsprechen mit Ausnahme der „Beispielhaften Darstellung der Zitation anhand des Beitrages“ (Zettlr 1.8.3, macOS) der Zettlr-Version 1.8.2 (macOS). Die bis zu dieser Stelle verwendeten Screenshots entstammen der Version 1.8 von Zettlr.

Einstellungen

Das Einstellungsmenü von Zettlr verbirgt sich oben links hinter dem Zahnrad-Symbol:

Das Einstellungsmenü in Zettlr.

Für formale Optionen werfen wir hier zunächst einen Blick in den Reiter „Allgemein“:

Allgemein

• Dunkles Thema;
• Zusätzliche Dateiinformationen (Informationen wie Datum werden im linken Frame bei der Dateiablage direkt sichtbar);
• Dateimanager-Ansicht (linker Frame, persönlicher Favorit ist hier die erweiterte Ansicht, die eine Extra-Spalte für die Unterordner der jeweiligen Oberordner öffnet, Alternative für mehr Schreibplatz in der Breite ist die Ansicht „kombiniert“).

Allgemeine Einstellungsmöglichkeiten in Zettlr.

Editor

Im Tab Editor haben wir keine weiteren Änderungen vorgenommen.

Export
Im Tab Export gibt es für uns zwei wichtige Einstellungsmöglichkeiten:

• Zitationsdatenbank;
• CSL-Styledatei.

Verknüpfung von Zitationsdatenbank und CSL-Datei.

Unter Zitationsdatenbank ist unsere Datei mit Literaturinformationen zu verstehen, die wir mit dem jeweils gerade geöffneten Dokument verknüpfen wollen. Erstellen wir also mit Zotero eine Datenbank und speichern diese als bib-Datei ab, so kann diese an dieser Stelle mit unserem Dokument verknüpft werden. Haben wir dies getan, so lassen sich die jeweiligen Stellen in einem Text mit der dazugehörigen Literaturinformation verbinden.

Mit der CSL-Styledatei sagen wir Zettlr, nach welchem Zitationsstil Zitationen in unserem Text angezeigt werden sollen. CSL-Dateien gibt es unter anderem auf der Webseite Citation Style Language beziehungsweise über das dort verlinkte CSL Style Repository. Wir haben uns für die Aufbereitung der Artikel von kommunikation@gesellschaft so beispielsweise für den Zitationsstil der Deutschen Gesellschaft für Psychologie (DGPs) entschieden. Die Datei wird nach dem Download an einem Ort unserer Wahl auf dem Rechner abgelegt und an dieser Stelle mit Zettlr verknüpft. Beispielhaft machen wir dies in der folgenden Darstellung mit dem oben erwähnten Zitationsstil:

Einbindung des Zitationsstils der DGPs.

Nachdem wir unser Dokument im Beispiel sowohl mit unserer Literaturdatenbank als auch mit einem Zitationsstil über die CSL-Datei verknüpft haben, kann durch Verwendung von Klammern und @-Zeichen ein direkter Zugriff auf die Literaturdatenbank erfolgen:

Haben wir eine Stelle im Text, an der eine Litertaurquelle eingebunden werden soll, so leiten wir diese Zitation mit einem @-Zeichen ein.

In einem exportierten Dokument – zum Beispiel einer PDF-Datei – wird die Zitation den Informationen des ausgewählten Zitationsstiles entsprechend abgebildet:

Beispielhafte Darstellung der Zitation anhand des Beitrages.

Das war es. Nun können wir unsere wissenschaftlichen Texte mit dem Markdown-Editor Zettlr verfassen und in die jeweils benötigten Formate exportieren.

Zitationsansetzung
Es gibt natürlich zahlreiche Möglichkeiten eine Zitation anzusetzen. Soll – wie oftmals üblich – mit mehr Informationen als Autor:innen und Jahr zitiert werden, so muss der Zitationsschlüssel wie oben abgebildet in eckige Klammern gesetzt werden, während mit weiteren Informationen vor und nach diesem Schlüssel eine Erweiterung der Literaturangaben – beispielsweise um Seitenzahlen – erfolgt:

•  [@Musterfrau2020, 3-5]

Auch mehrere Literaturquellen können angesetzt werden:

•  [@Musterfrau2020, 3-5; @Mustermann, 8-9]

Weitere Möglichkeiten zur Ansetzung der Zitation können in der Dokumentation von Zettlr unter dem Punkt Zitieren mit Zettlr eingesehen werden.

Kurzbetrachtung der Oberfläche von Zettlr

Wir haben im vergangenen Beitrag u.a. diese Features von Zettlr aufgeführt und wollen diese nun kurz im Rahmen der Oberfläche aufzeigen:

Promodoro-Timer
Die Promodoro-Technik ist eine Methode des Zeitmanagements, bei der die vorhandene Zeit in feste Arbeits- und Pausenzeiten eingeteilt wird. Die Arbeit in Intervallen soll dem Fokus und der Produktivität der Schreibenden dienen.

Der Promodoro-Timer in Zettlr kann individuell genutzt werden.

Schreibstatistiken
Zettlr bietet Schreibenden auch eine Auswahl an Schreibstatistiken. Neben Wortzählung lassen sich hier über erweiterte Optionen auch Vergleiche zu anderen Schreibzeiträumen ziehen.

Schreibstatistiken in Zettlr.

Dateiinformationen anzeigen
Neben generellen Schreibstatistiken bietet Zettlr am oberen rechten Bildschirmrand Dateiinformationen zum aktuell geöffneten Schreibprojekt.

Für jedes Dokument stehen Dateiinformationen zur Verfügung.

Lesbarkeitsmodus
Der Lesbarkeitsmodus von Zettlr liefert – farblich kodierte – Einschätzungen zur Lesbarkeit des vorliegenden Textes. Somit kann bei Bedarf eine Unterstützung zur Verbesserung der Lesbarkeit in Anspruch genommen werden.

Farbliche Hervorhebungen im Lesbarkeitsmodus.

Zettelkastenfunktion
Der Zettelkasten ist ein bekannter Ansatz aus dem Bereich des wissenschaftlichen Arbeitens. Die – vom Soziologen Niklas Luhman entwickelte – Methode setzt auf die Verknüpfung kürzerer und umfassenderer Notizen. Wie zu Beitragsbeginn erwähnt gibt es Eindrücke dazu in diesem Beitrag aus der Beitragsreihe #Notizschreibwochen2020.

Sollten noch Fragen zu diesen und weiteren Funktionen von Zettlr offen bleiben, so empfiehlt sich natürlich auch ein Blick in die umfassende Dokumentation.

Dateiimport mit Zettlr

Neben dem oben vorgestellten Dateiexport lassen sich mit Zettlr natürlich auch Dateiimporte realisieren. Im Projekt Modernes Publizieren haben wir so unter anderem für die Neuveröffentlichung des Journals kommunikation@gesellschaft ältere Beiträge, die im DOCX-Format vorlagen, in Markdown konvertiert, um diese für die Weiterverarbeitung hin zu einer Veröffentlichung nach Standards einer offenen Wissenschaft aufzubereiten. Anfangs wurden diese Importe noch direkt über Pandoc mittels Kommandozeilen umgesetzt, im weiteren Projektverlauf erwies sich die Konvertierung mit Zettlr jedoch als ebenso sauber und zeiteffizienter. Nachdem LaTeX und Pandoc installiert wurden, ist dies über Zettlr nämlich mit wenigen Mausklicks umsetzbar.

Dazu gehen wir in Zettlr am oberen Bildschirmrand auf den Punkt „Datei“ und wählen „Dateien importieren“.

Der Dateiimport in Zettlr funktioniert auf Klick ohne Kommandozeile.

Nun muss nur noch die entsprechende Datei ausgewählt und die Auswahl bestätigt werden. Innerhalb weniger Sekunden generiert Zettlr bereits eine – natürlich auch abhängig von der Komplexität der Urquelle – sehr sauber konvertierte Markdowndatei.

Bei Interesse und Neugier an der Nutzung von Zettlr bietet sich als möglicher Test auch ein – bereits in proprietären Schreibumgebungen wie Word begonnendes – Schreibprojekt an, da es mit wenigen Mausklicks importiert werden kann.

Fazit

Zettlr ist dank einiger Features, die für den Schreibprozess hilfreich sind eine gute Möglichkeit, ohne zu viele Optionen, die die Anwendung ausbremsen oder unübersichtlich werden lassen, in Markdown Texte unterschiedlicher Art zu verfassen und bei Bedarf auf Knopfdruck in zahlreiche Formate zu exportieren. Die Installation ist verhältnismäßig einfach durchzuführen, auch wenn es nach der Installation des Basisprogrammes für bestimmte Funktionen zusätzlicher Installationen wie Pandoc und LaTeX bedarf.

Wie vielleicht bereits in diesem Beitrag deutlich wurde, bringt das Schreiben in Markdown viele Vorteile mit sich, so dass sich unserer Meinung nach auch nach jahrelanger Schreibarbeit mit Word, Pages und anderen proprietären Schreibanwendungen zumindest das Ausprobieren neuer Schreibmöglichkeiten, -anwendungen und -kulturen wie beispielsweise mit Zettlr lohnt.

Was haltet ihr von Zettlr? Habt ihr diesen oder andere Markdowneditoren bereits ausprobiert oder plant es? Teil es uns gerne in den Kommentaren mit.

Weiternutzung als OER ausdrücklich erlaubt: Dieses Werk und dessen Inhalte sind – sofern nicht anders angegeben – lizenziert unter CC BY 4.0. Nennung gemäß TULLU-Regel bitte wie folgt: „Schreiben mit Zettlr – Open-Source-Markdowneditor für Texte aller Art“ von Florian Hagen und Axel Dürkop, Lizenz: CC BY 4.0. Beitragsbild „Füller“ von Florian Hagen (CC BY 4.0.). Der Beitrag steht als Markdown-, DOCX- und PDF-Datei zur Verfügung.