Wissenschaftliche Dokumente in Markdown schreiben?

  Ralf Hersel   Lesezeit: 9 Minuten  🗪 22 Kommentare

Für das Schreiben und Publizieren von wissenschaftlichen Arbeiten wird häufig LaTeX verwendet, insbesondere bei technischen oder naturwissenschaftlichen Themen. Die andere Hälfte verwendet eine normale Textverarbeitungssoftware. Doch geht das auch mit Markdown?

wissenschaftliche dokumente in markdown schreiben?

Inspiriert durch einen Artikel bei Curius, in dem es um LaTeX versus Textverarbeitung beim Schreiben und Verlegen von wissenschaftlichen Dokumenten geht, stellte sich mir die Frage, ob man solche Arbeiten mit Markdown erstellen kann. Meine These lautet: Es ist nicht möglich, wissenschaftliche Dokumente in Markdown zu schreiben. Ob diese These stimmt oder nicht, wird sich im Verlauf dieses Artikels herausstellen.

Seitdem ich meine letzte wissenschaftliche Arbeit geschrieben habe, sind schon Jahrzehnte vergangen. Damals waren Word und WordPerfect das Mittel der Wahl. Ich hatte mich für WordPerfect entschieden, weil man darin in eine Markup-Ansicht umschalten konnte. Dadurch war es wesentlich einfacher, Probleme in der Formatierung zu erkennen, als bei der reinen "what you see is what you get"-Ansicht von Word. Diesen Vorteil sehe ich auch bei Markdown-Texten.

Bevor der Test beginnt, muss zunächst geklärt werden, welche Elemente bei einem wissenschaftlichen Text vonnöten sind und welches Endprodukt für die Veröffentlichungen erforderlich ist. Informationen zum Aufbau eines solchen Dokumentes findet man nach kurzer Suche im Internet, wie zum Beispiel in diesem Online-Leitfaden für wissenschaftliches Arbeiten als da wären: Deckblatt, Titelblatt, Widmung, Geleitwort, Motto, Vorwort, Inhaltsverzeichnis, Verzeichnis der Abbildungen, Verzeichnis der Tabellen, Verzeichnis der Abkürzungen, Glossar, Zusammenfassung, Abstract, Einleitung, Hauptteil, Schlussteil, Literatur- und Quellenverzeichnis (Bibliografie), Anhang und Fussnoten.

Diese Inhaltstypen lassen sich auf folgende Syntax-Elemente herunterbrechen:

  • Text
  • Überschriften und Gliederungsebenen
  • Formatierung
  • Abbildungen (Bilder, Formeln)
  • Tabellen
  • Verweise und Verzeichnisse (Literatur, Quellen, Fussnoten, Inhalt, Abbildungen, Tabellen, Abkürzungen)

Beim Endprodukt solle die rohe Markdown-Datei, ein PDF oder eine HTML-Datei ausreichend sein. Um meine These zu widerlegen oder zu bestätigen habe ich den Markdown-Editor MarkText verwendet, weil dieser ziemlich funktionsreich ist.

Text, Überschriften und Gliederungsebenen

Ok, Text und Überschriften sind trivial; das muss man nicht testen. Interessanter wird es bei der Gliederung:

Überschriften mit verschiedenen Gliederungsebenen sind kein Problem. Was jedoch nicht geht, sind automatisch nummerierte Überschriften. Zwar lassen sich Aufzählungen mit Überschriften kombinieren, das führt jedoch zu einer unbefriedigenden Formatierung und einer fortgeführten Nummerierung im Textbereich unterhalb der Überschrift:

Das kann man Drehen und Wenden wie man will, man kommt nicht zum gewünschten Ergebnis. Es spielt keine Rolle, ob man zuerst aufzählt und dann titelt, oder umgekehrt. Ausserdem funktioniert bei dieser Kombination das Einfügen von Aufzählungen innerhalb nicht. Um den Test an dieser Stelle nicht gleich zu beenden, empfehle ich mit handnummerierten Überschriften fortzufahren. Das bedingt eine Überarbeitung aller Kapitelnummerierungen am Ende der Arbeit, was nervig und fehleranfällig ist.

Die Gliederungshaltigkeit hängt vom verwendeten Markdown-Editor ab. Mit dem Werkzeug ReText konnte ich bessere Ergebnisse erzielen als mit MarkText. Hier ist ein Beispiel:

Textformatierung

Markdown bietet ausreichende Möglichkeiten zur Formatierung von Text. Hier sind ein paar Beispiele:

Weiterhin gibt es Formatierungen für Code (inline und Block), Zitate, Formeln und HTML.

Abbildungen

Bilder können in allen Markdown-Editoren ![alt text](image.jpg) eingebunden werden. Mathematische Formeln gehören nicht zur Standardsyntax von Markdown-Editoren. ReText kann es nicht, wohl aber MarkText. Dabei werden meist LaTeX-formatierte Ausdrücke verwendet, die von MathJax dargestellt werden. Die Formeln können inline ($formel$) oder als Block ($$formel$$) dargestellt werden. Hier ist eine Block-Darstellung im Editor MarkText:

Tabellen

Standardmässig kann Markdown Tabellen darstellen, wobei dies unbequem und nicht sehr formatreich ist. Hier ist ein Beispiel in ReText:

Wie man sieht, wird die Tabelle mit "Strichen gemalt". Fortgeschrittene Markdown-Editoren stellen Hilfseditoren für Tabellen zur Verfügung, so auch MarkText:

Dennoch darf man bei Tabellen in Markdown keine Formatierungswunder erwarten.

Verweise und Verzeichnisse

Fussnoten werden von der Markdown-Syntax gut unterstützt. Sie werden mit [^1] eingeleitet und mit [^1]: beschrieben. Statt einer Nummerierung kann auch Text verwendet werden. Ausserdem werden mehrzeilige Fussnoten unterstützt:

Ein Literatur- oder Quellenverzeichnis lässt sich ebenfalls mit der Syntax für Fussnoten erstellen. Bei umfangreichen Verzeichnissen lohnt sich jedoch die Verwendung einer Literaturverwaltung, wie z. B. Zotero. Daraus kann der ganze untere Teil des Literaturverzeichnisses als Markdown-Text generiert werden. In diesem Artikel werden die verschiedenen Möglichkeiten ausführlich beschrieben.

Leider habe ich keine Möglichkeit gefunden, verschiedene Verzeichnisse (Fussnoten, Literatur, Abbildungsverzeichnis, Tabellenverzeichnis usw.) voneinander zu unterscheiden. Wie man im vorherigen Screenshot sieht, landen alle Verweise an derselben Stelle unterhalb des Textes. Das liegt jedoch an ReText; mit dem Editor MarkText werden die Einträge an der richtigen Stelle eingefügt. Dafür hat MarkText Schwierigkeiten bei der Formatierung der Verweisnummern und -Links:

Markdown bietet von Haus aus kein automatisches Inhaltsverzeichnis. Manche Editoren stellen Makros bereit, die das Inhaltsverzeichnis aufbauen. Falls der Editor das nicht kann, muss man sich mit Bordmitteln behelfen und das Verzeichnis manuell aufbauen und pflegen. Voraussetzung für dieses Beispiel ist, dass der Editor Custom IDs für Headings unterstützt. Das geht so:

Fazit

Meine zu Beginn dieses Artikels geäusserte These lautete: Es ist nicht möglich, wissenschaftliche Dokumente in Markdown zu schreiben. Obwohl mir das Ergebnis nicht gefällt, bleibe ich dabei. Grundsätzlich bietet Markdown zwar alle Bestandteile, die für wissenschaftliche Texte notwendig sind, jedoch nicht ohne Weiteres. Es kommt sehr auf den verwendeten Editor an, bzw. auf die Erweiterungen, die dieser bietet und darauf, wie gut die Standardelemente von Markdown umgesetzt werden. Als Beispiel möchte ich die Probleme bei der Gliederungshaltigkeit anführen. Man möchte kein 50-seitiges Dokument schreiben, bei dem einem die Gliederung und Nummerierung der Kapitel um die Ohren fliegt.

Wenn ihr anderer Meinung seid oder Lösungen für die genannten Herausforderungen kennt, schreibt sie bitte in die Kommentare.

Quellen:

https://www.markdownguide.org/

https://www.zotero.org/

https://github.com/marktext/marktext

https://github.com/retext-project/retext

Bildquelle: https://de.wikipedia.org/wiki/Vitruvianischer_Mensch

Tags

Wissenschaft, Dokument, LaTex, markdown

fedora
Geschrieben von fedora am 12. Februar 2024 um 11:54

Wäre das nicht eine Aufgabe die sich zum Beispiel mit Obsidian umsetzen ließe?

PandocGuy
Geschrieben von PandocGuy am 12. Februar 2024 um 12:07

Tatsächlich bin ich anderer Meinung, was die Machbarkeit angeht. Es geht mit einer Mischung an Werkzeugen , keinesfalls mit einem MD Editor alleine, das ist auch nicht seine primäre Aufgabe.

Mit: Zettlr - als MD Editor und zur Einbindung der Literaturdatenbank um richtig zitieren zu können

Zotero - mit BetterbibTex Addon mit Auto Update und Exportfunktion der LiteraturDB in ein Verzeichnis für Zettlr

Pandoc - schnürt die .md mit wenigen Befehlen in eine PDF

Yaml Header - definiert mit vielen Einzelbefehlen das gewünschte Aussehen und Verhalten der zu erstellenden Datei

Custom Latex Befehle - in der .md sorgen für alle nötigen Formatierungsregeln

Moonbase59
Geschrieben von Moonbase59 am 12. Februar 2024 um 13:21

Hallo, ich behaupte jetzt mal ganz ketzerisch das Gegenteil. Ich mag Markdown, weil man damit einfach aus einer Quelle viele Ergebnisse erzielen kann: Wissenschaftliche Dokumente mit ordentlichen Inhaltsverzeichnissen, automatischer Gliederung, Literatur- und Quellenangaben, Formeln, E-Books, druckfertige PDF-Dokumente usw.

Es erfordert allerdings einen ziemlichen initialen Aufwand, alles passend einzurichten: Markdown-Editor, LaTeX, BibTex, JabRef, Pandoc, etc. Außerdem werden die YAML-Header im Markdown immer länger. Der Aufwand dürfte sich also nur lohnen, wenn man über lange Zeit an einer umfangreichen Arbeit schreibt oder aber viele kleinere, gleichartige Publikationen schreiben möchte.

Ich hatte 2015 ein Buch angefangen ("Linux für Dich: Electronic Publishing mit Markdown"; allerdings nie beendet), in dem all die Arbeitsabläufe und Installation der Werkzeuge beschrieben wurde. Allerdings hat mich damals die permanente Weiterentwicklung der Software und der Zeitmangel etwas überrollt.

Aber: Es geht doch. Wenn einmal alles eingerichtet ist, die Präambeln fertig sind und die Generierung über Pandoc und LaTeX »auf Knopfdruck« eingerichtet ist, macht das Arbeiten mit »single source« sogar richtig Freude: Fertige Druckvorlage nach Verlagsvorgaben als PDF, gleichzeitig ein gut lesbares E-Book oder HTML – wirklich prima.

Man sollte das Thema im Hinterkopf behalten und ab und zu mal nachverfolgen, denke ich. Oder anhand eines echten Projekts mal »durchboxen«.

Oelauge
Geschrieben von Oelauge am 12. Februar 2024 um 13:34

Hallo, das ist sehr interessant. Ich denke aber, dass Du mit Deiner Aussage:"Es kommt sehr auf den verwendeten Editor an ..." schon die Antwort gegeben hast. Ich habe zwar mit Markdown noch keine wissenschaftliche Arbeit geschrieben, bin aber in Kombination mit LaTeX sehr nahe heran gekommen. Wie das funktioniert? Ich habe mit einer Erweiterung von Markdown, mit Multimarkdown, ein kleines Buch geschrieben. Mich dabei komplett im Texteditor bewegt, also ohne einer Vorschau oder Dergleichen und mit Pandoc die Konvertierung vorgenommen. Pandoc nimmt bei der Konvertierung zum PDF einen LateX-Zwischenschritt auf, in dem man mit einer eigenen Präambel eingreifen kann. So lassen sich neben der Verzeichnisgestaltung (mit richtiger Formatierung), auch als Beispiel die Papiergröße samt Ränder einstellen. Die Gestaltung von Tabellen ist ohne Hilfe sperrig, aber hier bieten manche Editoren eine Art Unterstützung an, um den Aufbau mit den Sonderzeichen einigermaßen in den Griff zu bekommen. Der Word- oder HTML-Export funktioniert ebenfalls ganz gut. Aber ich gebe zu, dass es mehr Zeit zu investieren gibt, wenn noch nie mit LaTeX gearbeitet wurde, bzw. um die Arbeitsweise von Pandoc zu durchleuchten.

s3bbo
Geschrieben von s3bbo am 12. Februar 2024 um 14:08

Also eine Wissenschaftliche Arbeit direkt und ausschließlich in Markdown zu schreiben ist vermutlich weniger möglich. Aber ich wundere mich das Pandoc (https://pandoc.org/) gar nicht erwähnt wird. Ein Komilitone und ich haben jeweils unsere Bachelorarbeit und einige Hausarbeiten in Markdown geschrieben und mit Pandoc nach LaTeX übersetzt.

kamome
Geschrieben von kamome am 12. Februar 2024 um 14:27

asciidoc(tor) FTW! (und vielleicht pandoc)

Nicht sicher, ob damit alles erledigt werden kann, aber deutlich mehr!

Naja
Geschrieben von Naja am 13. Februar 2024 um 09:02

Aber ist das weniger komplex als LaTeX? Kommt mir nicht so vor.

tux.
Geschrieben von tux. am 12. Februar 2024 um 14:57

Ich benutze ja einfach groff - das ist LaTeX in vielerlei Hinsicht überlegen (kann nicht deutlich weniger und passt trotzdem auf eine Diskette). ;-)

Claire Grube
Geschrieben von Claire Grube am 12. Februar 2024 um 15:38

Es gäbe da sicherlich gleich mehrere Möglichkeiten, und eine nicht ganz unwesentlich Bedeutung spielt hier freilich auch "das Weitere" 😜️

Naheliegend wäre –was ich vermutlich auch machen würde– mit einem "Rahmen Latex-Dokument" zu arbeiten, um dann einzelne Abschnitte/ Kapitel in Markdown zu schreiben (mit *tex über pandoc). Dass ggf. händisch noch nachoptimiert werden müsste, mag sein.

Was auch ginge, wäre Markdown –wieder in Kombination mit pandoc– und einem "template" pandoc "--reference-doc". Man kann *.odt (LO Writer) und auch –per libreoffice --headless --convert-to docx –wozu auch immer– "Wordokumente" erzeugen.

Hugo
Geschrieben von Hugo am 12. Februar 2024 um 18:27

Geht alles. Lesetipp für Anfänger: https://kofler.info/ebooks/markdown_pandoc/

Naja
Geschrieben von Naja am 13. Februar 2024 um 09:01

Auch er schreibt, dass der Aufwand erheblich ist. Fragt sich, was sinnvoller ist, sich mit LaTeX auseinanderzusetzen oder der ganze Aufwand, um mit Markdown klarzukommen.

Alfons
Geschrieben von Alfons am 12. Februar 2024 um 19:31

Für eine Abschlussarbeit gilt wohl, ob und mit welchem Aufwand sich die formalen Vorgaben erfüllen lassen.

Für einen Fachartikel zählt, ob die wissenschaftliche Fachzeitschrift das eingereichte Manuskript akzeptiert.

Da gibt es außer LaTeX und Word (und Verwandte) nun mal keine akzeptierte Alternative. Typst wäre ja auch ein interessanter Nachfolger - aber kein Verlag wird das annehmen. Und die sind ohnehin ziemlich träge...

Christoph
Geschrieben von Christoph am 13. Februar 2024 um 21:48

Das ist ein sehr wichtiger Gesichtspunkt! In all den Fällen wo das Textformat vorgegeben wird (eben meist LaTeX oder Word), muss in die Betrachtung des Workflows unbedingt die abschließende Konvertierung des Textes in Word oder LaTeX einbezogen werden.

Robert
Geschrieben von Robert am 12. Februar 2024 um 23:01

Vielleicht ist das alles auch ganz einfach mit Typora (https://typora.io/) machbar? Ist zwar kostenpflichtig, aber es existiert eine kostenlose 15-Tage Testversion für bis zu 3 Geräte. Gibt es Cross-Plattform für Win/Linux/MacOS und wird aktiv weiterentwickelt (https://typora.io/releases/all).

Chris
Geschrieben von Chris am 13. Februar 2024 um 07:55

r-bookdown (https://bookdown.org/home/) wäre noch eine Möglichkeit. Dazu RStudio. Damit kann man jedes Dokument in html, epub und pdf konvertieren. Aber ich verwende den Server und die IDE im Browser. RStudio Desktop ist ein Server und Browser in einem Electron Monster verpackt.

Was die ganzen Markdown Editoren angeht, vielleicht bin ich zu pingelig, aber keiner von denen sagt mir zu. Für einfaches MD verwende ich KWrite und fertig.

Chris
Geschrieben von Chris am 13. Februar 2024 um 12:12

Vor 2 Jahren hatte ich mal ein Buch Projekt unterstützt. Da verwendete ich Markdown Dateien die dann in CoNTexT eingebunden waren für die PDFs (und Bookdown für ePub). Aber diesen Workflow würde ich noch mal machen. Sich die Infos bei Context zu holen ist mühsam, viele alte Wiki Seiten, gefühlt 100 verschiedene Anleitungen.

Chris
Geschrieben von Chris am 13. Februar 2024 um 12:16

*nicht nochmal

Tuxnix
Geschrieben von Tuxnix am 13. Februar 2024 um 16:07

Mit Markdown kann man flüssig einzelne Abschnitte schreiben Und kann kopiert man den Text in sein Latex Dokument.

Das hätte den Vorteil, dass man beim Schreiben frei von Ablenkungen ist und dass man sich dann in Latex auf Sachen wie die Kapitalnummerierung, Formeln ect.pp. konzentriert. Dabei muss man dann auch keine Verrenkungen in Markdown machen für all die Dinge die Latex ohnehin besser kann.

Naja
Geschrieben von Naja am 13. Februar 2024 um 23:47

Mit Markdown kann man flüssig einzelne Abschnitte schreiben Und kann kopiert man den Text in sein Latex Dokument. Wozu das denn? Warum nicht gleich in tex?

tuxnix
Geschrieben von tuxnix am 14. Februar 2024 um 17:57

Wenn man hier schon Markdown ins Spiel bringt, dann sollte man dabei auch seine Stärken nutzen. Das ist das flüssige Scheiben ohne viel Editiergedöns.

Natürlich kannst du auch ganz auf Markdown verzichten und gleich alles in tex schreiben. Das war aber hier nicht die Fragestellung.

Experte
Geschrieben von Experte am 13. Februar 2024 um 19:26

Einfach LyX nutzen. Problem solved.

defender
Geschrieben von defender am 15. Februar 2024 um 13:28

Hallo zusammen,

ich habe die letzten Jahre an der Uni meine Arbeiten immer abseits bekannter Textverarbeitungssoftware wie Libreoffice Writer oder dergleichen verfasst. Die Einstiegshürde war doch sehr hoch, wie ich finde, da vieles an Dokumentation, das ich zur Einrichtung gelesen habe, leider teils schon wieder veraltet war.

Angefangen hatte ich mit RMarkdown. Praktisch, da man damit leicht auch Graphen usw. mit einbauen kann, die mittels R-Code gebaut sind. Wenn's mal eine Arbeit ohne viele Abbildungen wurde, dann standardmäßiges Markdown. Habe das dann in Vim im Terminal runtergeschrieben, per xelatex kompiliert, fertig. Ging MEIST problemlos. Dann habe ich Emacs und den Org-Mode entdeckt, was seitdem mein Standardprogramm dafür ist. Die Einrichtung ist auch hier einigermaßen komplex für Neulinge (wie mich... :D), aber wenn es einmal funktioniert, genial. Möchte ich nicht mehr missen! Ich nutze momentan Doom Emacs, da war vieles für mich passend voreingestellt. Da brauchte ich nur noch ein gutes Template für den Latex-Export zu erstellen. Auch Zitationen funktionieren intern im Org-Mode gut; man kommt aber auch da nicht umhin, sich mit CSL-Styles zu beschäftigen, um Layout-Vorschriften passend umsetzen zu können.

Den wichtigsten Satz finde ich: "Es kommt auf den Editor an", das unterschreibe ich zu 100%. Hätte ich (Doom) Emacs nicht zur Hand, würde ich sicherlich den Org-Mode nicht so oft nutzen, wie ich es tue. Also: es geht, aber man braucht grade zu Anfang eine höhere Frustrationstoleranz, bis alles einmal sitzt...