Markdown - Eine Übersicht

HINWEIS: Diese Seite befindet sich noch in der Überarbeitung. Es handelt sich nicht um die finale Version, dementsprechend könnten Inhalte unvollständig sein bzw. die Struktur unübersichtlich.

Als vereinfachte Auszeichnungssprache dient Markdown dazu, für den jeweiligen Ersteller leicht zu lesen und leicht zu schreiben zu sein. Während HTML eine längere Einarbeitung in Tags und Formatierungsbefehle erfordert, können in Markdown Texte mit nur wenigen Mitteln umgesetzt werden. Der Katalog der Möglichkeiten, die Markdown bietet, ist zwar beschränkt, allerdings lässt sich für komplexere Sachverhalte und Darstellung auf einfache Weise HMTL direkt in den geschriebenen Markdown-Text integrieren.

Um Markdown so einfach wie möglich zu halten, wird nicht nur ein geringerer Befehlsapparat genutzt. Auch die genutzten Formalia sollen in ihrer Gestalt dem Endergebnis so ähnlich wie möglich sein. So sind kursive Elemente als Hervorhebung auch innerhalb der Markdown-Syntax einfach zu erkennen und übersichtliche Darstellungen wie Listen und Tabellen sehen so aus, wie Listen und Tabellen aussehen sollten.

Bei der Arbeitsgruppe Studium für Blinde und Sehbehinderte nutzen wir das Markdown-Format, um auf einfache Weise Literatur in barrierefreie HTML-Dokumente umzusetzen. Durch den steten Wachstum der Nachfrage an solchen Dokumenten, müssen auf der einen Seite mehr studentische Hilfskräfte aus unterschiedlichsten Studienbereichen auch ohne tiefere Kenntnisse von Auszeichnungssprachen angestellt und auf der anderen Seite der Umsetzungsprozess optimiert werden. Die einfache Syntax von Markdown unterstützt bei der AGSBS diese Ziele. Eine spätere Konvertierung ins HTML-Format wird durch Matuc gewährleistet.

In dieser Übersicht stellen wir die verschiedenen Elemente von Markdown genauer vor und präsentieren Anwendungsbeispiele, wie sie bei der Übertragung von Dokumenten innerhalb der AGSBS vorkommen können. An einigen Stellen werden Quellcode-Beispiele genutzt, die anschließend von einer visuellen Darstellung des jeweiligen Codes in HTML begleitet werden. Diese sollen eine Vorstellung davon schaffen, wie der geschriebene Markdown-Text eines zu übertragenden Dokumentes in seinem Endprodukt aussehen kann.

Auszeichnung von Text und anderen Elementen eines Dokuments

Überschriften

Markdown unterstützt die Formatierung von insgesamt sechs verschiedenen Überschriften-Ebenen. Dabei beginnt jedes Kapitel aus der AGSBS-Struktur erneut bei der Überschrift erster Ebene, um beim späteren Konvertierungsprozess ein übersichtliches Inhaltsverzeichnis erzeugen zu können.

Es gibt zwei Möglichkeiten, um Überschriften in Markdown zu erzeugen. Die Unterschiede betreffen allerdings nur die Überschriften der ersten und zweiten Ebene:

Überschrift 1. Ebene (H1)
=========================

Überschrift 2. Ebene (H2)
-------------------------


#Überschrift 1. Ebene (H1)

##Überschrift 2. Ebene (H2)

Alle anderen Ebenen werden durch die Anzahl der vorhandenen Rauten bestimmt:

###Überschrift 3. Ebene

####Überschrift 4. Ebene

#####Überschrift 5. Ebene

######Überschrift 6. Ebene

!!!Visuelle Darstellung

Zum gegenwärtigen Stand müssen bei der AGSBS etwaige Nummerierungen in der Überschrift mit übertragen werden, obwohl im Inhaltsverzeichnis diese Nummerierungen automatisch generiert werden. Diese werden allerdings auf der jeweiligen Seite innerhalb des Textes nicht automatisch generiert. Ein Weglassen dieser Zahlen verfälscht das Prinzip der Zitierfähigkeit, weswegen nach einer technischen Lösung für dieses Problem gesucht wird.