Markdown zur Texterfassung

Wenn Texte aus unterschiedlichen Quellen zusammengetragen werden, stehen vielfältige Textformatierungen, unterschiedliche Textverarbeitungsprogramme und aufwändige Einarbeitung in eine endgültiges Dokument oft im Weg. Dieser Beitrag zeigt, eine Möglichkeit, um den Austausch und die Einarbeitung zu vereinfachen.

[cmtoc_table_of_contents]

Dateiaustausch mit Markdown vereinfachen

Wer in einem größeren Team schon Dateien von Office-Programmen intensiv kombiniert hat, weiß, welche Herausforderungen bei einem solchen Unterfangen auftreten. Da wünschen sich manche die Zeit zurück, in der die Dokumentation einfach als Text gespeichert wurde.
Leider musste dann auf Textmarkierungen, auf Bilder, auf Tabellen und eine angenehm zu lesende Schrift verzichten.
Diese Nachteile können durch den Einsatz von Markdown überwunden werden.
Der Ablauf ist dann so:

  • Die Texte werden in einem einfachen Programm, zum Beispiel notepad erfasst.
  • Zur Markierung des Textes gibt es besondere Zeichen, die zeigen, wie der Buchstabe, das Wort oder der gesamte Abschnitt geschrieben wird.
  • Es gibt Zeichen für fett, kursiv, durchgestrichen, hochgestellt, tiefgestellt. Die Zeichen können kombiniert werden.
  • Für Absätze gibt es Fließtext, Überschriften, Zitate, nummerierte und unnummerierte Aufzählungen sowie Tabellen und Bilder.
  • Zusätzlich auch Markierungen für Programmierzeug.

Die meisten Texte kommen mit diesen Markierungen wirklich aus.
Wenn es nicht reicht, können direkte Formatierungen mit HTML eingearbeitet werden.
Damit aus der Textdatei ein schön lesbarer Text wird, ist ein Layoutprogramm nötig.
Dann entsteht aus der Textdatei eine Word-Datei, eine Präsentation, eine PDF-Datei oder noch mehr.
Das bedeutet anderseits, dass der Text nur einmal erfasst werden muss, aber mehrfach genutzt werden kann.
Als Layoutprogramme gibt es zum Beispiel pandoc zur Verfügung. Als Schreibprogramm kann panwriter genutzt werden. Dieses Programm kann den Text in viele weitere Formate übersetzen.

Grundlagen Markdown

Der englischsprachig Markdownguide hat kurze und knappe Übersichten von Zeichen zur Texterfassung. Dieser Artikel wurde hier ins Deutsche übertragen.

Textelement Markdownsyntax
Überschriften # Überschrift 1 (Titel)
## Überschrift 2 usw.
Fett fetter Text
Schrägschrift schräggestellter Text
Zitat > Zitat
Nummerierte Liste 1. Erster Eintrag
1. Zweiter Eintrag
1. Dritter Eintrag
Aufzählung – Erster Eintrag
– Zweiter Eintrag
– Dritter Eintrag
Linie
Verweis [Verweis](https://www.example.com)
Bild !Bildtext
Computerbefehl \Computerbefehl

Erweiterte Beschreibungen von Markdown

Folgende Elemente erweitern die Grundfunktionen und sind auf der Seite beschrieben und hier übersetzt.

Textelement Markdownsyntax
Tabelle | Element | Beschreibung \
| ———– | ———– \
| Überschrift | Title \
| Absatz | Text \
Fußnote Dieser Satz hat eine Fußnote. [^1]
[^1]: Das ist die Fußnote.
Überschriftsname ### Meine große Überschrift {#name-des-titels}
Glossarliste Benennung
: Beschreibung
Durchgestrichen Die Welt ist eine Scheibe.
Aufgabenlist – [x] Pressemitteilung schreiben
– [ ] Webseite aktualisieren
– [ ] Medien ansprechen
Emoji Das ist lustig! :joy:
Hervorhebung Ich muss dieses ==anstreichen==.
Tiefstellung H~2~O
Hochstellung X^2^
Programmbeispiel ““
{
  "Vorname": "Johann",
  "Nachname": "Dahm",
  "Alter": 25
}
“`

Vorteile und Nachteile von Markdown

Vorteile

  • Die Dateien sind nicht sehr umfangreich. Es gibt keinen Wasserkopf wie in Textverarbeitungsprogrammen
  • Die Zeichen zur Textbearbeitung sind leicht erlernbar
  • Textprogramme werden nicht benötigt, ein editor reicht völlig aus.
  • HTML-Zeichen können in den Text eingefügt werden
  • Große Datensicherheit, da – fast – reiner Text übertragen wird.

Nachteile

  • Texte müssen für das endgültige Layout von einem zusätzlichen Programm verarbeitet werden.
  • fehlende Beschreibungen für Tabellen- und Bildbeschriftung
  • Je nach Layoutorogramm kann das Aussehen abweichen, dafür ist das Layout anpassbar.
  • Nicht alle Layouter beherrschen alle Zeicen von Markdown.
  • Korrekturanmerkungen sind direkt in der Datei nicht leicht darstellbar.

Weitere Quellen zu Markdown

Quellennachweis

Haus Hof Garten Teller
  • Haus Hof Garten Teller
  • Er arbeitet gern im Garten. Manche sagen, er ist ein Gartenanhänger, aber der Wortwitz wäre zu abgedroschen. Vor allem schneidet er gern Obst- oder Ziergehölz. Seit vielen Jahren wohnt er in einem Haus und Essen gehört zu seiner täglichen Routine. Und er interessiert sich für Dinge, die in- und außerhalb des Gehöfts passieren.

-+=