Vorlage
Dieser Artikel fast die wichtigsten Information für das Verfassen eines NFDI4Earth Living Handbook-Artikels zusammen.
Er enthält Informationen über die Metadaten, mit denen ein Living Handbook-Artikel beschrieben wird, die empfohlene Struktur von Artikeln, wie Abbildungen, Links und andere externe Inhalte eingefügt werden sowie über den Umgang mit Quellenachweisen. Artikel des Living Handbook sind in Markdown geschrieben. Daher enthält dieser Artikel auch einige Anleitungen zur Formatierung von Text und dem Einfügen externer Inhalte in Markdown. Auch wenn das Editorial Board ausdrücklich zum Einreichen von Artikeln in Markdown auffordert, stellen es diesen Vorlagen-Artikel auch im Word-Format .docx zur Verfügung. Die Inhalte der beiden Vorlagen-Artikel unterscheiden sich in den Teilen, die das jeweilige Dateiformat betreffen.
Metadaten
Um die Metadaten zu sehen, muss dieser Artikel in der unformatierten Version gelesen werden. In dieser sind die Metadaten von Zeilen mit --- eingeschlossen. Diese beschreiben den Artikel maschinenlesbar. Die entsprechenden Informationen müssen durch die den Artikel verfassende Person hinterlegt bzw. ersetzt werden. Anschließend können sämtliche mit # beginnenden Zeilen gelöscht werden.
Struktur von NFDI4Earth Living Handbook-Artikeln
Mit Ausnahme einiger weniger Artikeltypen gibt es keine festgelegte Gliederung von Living Handbook-Artikeln. Stattdessen sollte der Artikel in der für das Thema bestgeeigneten Weise gegliedert werden. Zur Vereinfachung des Verständnisses wird ein “spiral-out”-Ansatz empfohlen. Dies bedeutet, dass der Kern des Themas als Erstes behandelt wird, anschließend sämtliche Hauptaspekte des Themas eingeführt werden und erst dann detaillierte Ausführungen zu einigen oder allen Hauptaspekten folgen. Diese Art der Gliederung erlaubt es Lesenden ohne Vorwissen ein grundlegendes Verständnis des Themas zu entwickeln bevor sie mit Expertenwissen konfrontiert werden.
Sollte ein Thema sehr komplex sein, bietet es sich an, den Artikel in mehrere Artikel aufteilen und in diesen das Detailwissen zu vermitteln. Der „Haupt“artikel könnte dann beispielsweise eine Zusammenfassung des Themas bieten und auf die „Detail“artikel verweisen.
Medien und andere verlinkte oder eingebettete Inhalte
Medien und andere Inhalte können das Verständnis eines Artikels deutlich vereinfachen. Daher können sämtliche Medien und Nicht-Text-Inhalte in einem Artikel eingefügt werden. Dies beinhaltet auch interaktive Inhalte, beispielsweise Widgets, 3D-Modelle, Karten oder Jupyter Notebooks. Das Kapitel Schreiben in Markdown beinhaltet eine Liste, wie die verschiedenen Medien in einem Markdown-formatierten Artikel eingebettet werden. Falls ein für Ihren Artikel benötigter Inhaltstyp fehlt, kontaktieren sie bitte das Editorial Board via nfdi4earth-livinghandbook@tu-dresden.de. Es wird dann prüfen, wie Ihr Inhalt am besten eingebettet wird.
Quellennachweise
Quellennachweise sind ein wichtiger Bestandteil für die Glaubwürdigkeit eines Artikels. Darüber hinaus bieten sie wichtige Einstiegspunkte um sich intensiver mit dem Thema zu befassen. Daher müssen alle Inhalte mit geeigneten (beispielhaften) Quellennachweisen versehen sein. Open access-Publikationen und Ressourcen sind zu bevorzugen. Es besteht keine Notwendigkeit, eine erschöpfende Liste von Quellen zu erstellen. Es ist jedoch begrüßenswert, wenn der Artikel ein Kapitel „Weiterführende Information“ beinhaltet um Lesenden die Vertiefung des Themas zu vereinfachen.
Schreiben in Markdown
Das NFDI4Earth Living Handbook ist in Markdown geschrieben, wodurch ein hoher Grad an technologischer Flexibilität mit einem hohen Grad an Lesbarkeit des unformatierten Textes möglich ist. The Syntax für Markdown ist in diesem Cheat Sheet sehr gut erklärt. Zusätzlich dazu unterstützt das Living Handbook eine erweiterte Markdown-Syntax.
Einbinden von Medien/externen Inhalten
fügt eine Abbildung ein, die bei LINK hinterlegt ist. Die Bildunterschrift wird unter dem Bild platziert und der Alt text macht den Inhalt für Bildschirmlesegeräte zugänglich (und wird angezeigt, falls die Abbildung nicht geladen werden kann). Die Abbildungen werden automatisch nummeriert.[](https://www.youtube.com/watch?v=YOUTUBE-ID)fügt ein Video von YouTube ein, welches durch seine YOUTUBE-ID identifiziert wird. Analog zu Abbildungen wird die (Bild)unterschrift unter das Video platziert und der Alt text sollte eine Beschreibung/Zusammenfassung des Videos für Bildschirmlesegeräte enthalten.- Es kann reiner HTML-Code eingefügt werden, sodass zum Beispiel durch „Embed“-Elemente angebotene Code-Schnipsel via Kopieren/Einfügen im Artikel platziert werden können.