Syntax

Markdown - Auszeichnungssprache nach Gruber und Swartz

Die HTML Sprache erfordert eine Konvertierung des Textdokuments. Die Ausgangsform kann nicht zur Verwendung genommen werden, da Tags und Formatierungszeichen sichtbar sind. Der Markdown Syntax hat eine Vereinfachung zum Ziel, Lesbarkeit und Zeichenbedeutung sind ohne Formatierung des Textelementes in die Textgestaltung integriert. Die Programmierer haben sich an den Formatierungen von Nur-Text-Mails orientiert und die Programmsprache Markdown (nach unten Markieren)konzipiert. Markdown soll HTML nicht ersetzen, dies ist auf Grund des kleinen Bearbeitungsrahmens nicht möglich, jedoch sollen sich die Zeichensprachen ergänzen und zur allgemeinen Vereinfachung beitragen. Während Markdown eine Schreibformat darstellt, dient HTML als Publikationsformat. Die Markdown Elemente werden in das HTML Dokument integriert, somit kann der User das Ausgangsdokument im XHTML-Format formatieren. Markdown wurde primär für die Web- Dokumentengestaltung entwickelt.

Wichtige allgemeine Vorabinformationen zur Nutzung von Markdown und HTML

Formatierungshinweise

Kann eine Markdown Formatierung nicht angewendet werden, kann anstelle des Markdown Syntax ein HTML eingefügt werden. Das HTML wird einfach in den Text platziert, ohne Hervorhebung oder Anmerkung.
In einer HTML Block- Formatierung kann keine Markdown Syntax eingefügt werden, anders herum wird in jedem Markdown Syntax, ein Inline HTML Tag erkannt. Die Inline HTMLs können als Ersatz für die Markdown Syntax genommen werden.

Spezielle Zeichen gesondert hervorheben

Die linke Winkelklammer und das kaufmännische UND Zeichen bedürfen einer speziellen Bearbeitung in einem HTML Dokument. Die Zeichen werden markiert (die Winkelklammer mit dem Kürzel lt, das UND mit dem Kürzel amg). Das kaufmännische UND- Zeichen muss auch in URL-Adressen markiert werden, wenn es ein UND- Zeichen darstellen soll (jedoch nicht, wenn sie als selbst bezeichnendes Symbol in der Textsprache verwendet werden). In Code- oder Span Bausteinen werden die Winkelklammer und das kaufmännische UND automatisch codiert.

Block Elements - Blockelemente nach Markdown Syntax

Mit den Blockelementen wird dem Text ein individueller, äußerlicher Charakter zugeschrieben. Informationen, Zitate, Aussagen, Kopfzeilen oder Überschriften können durch textgestalterische Möglichkeiten des Markdown Syntax hervorgehoben und platziert werden. Jedem Blockelement steht eine eigene Zeichengebung zu.

Paragraphs and Line Breaks - Absätze und Zeilenumbrüche

Ein Absatz ist ein Textabschnitt, mit einer oder mehreren Zeilen. Die Abschnitte werden durch eine oder mehrere Leerzeilen vom Text getrennt, die gewohnte HTML unterstützte - Formatierung gelingt im Syntax nicht. Die Formatierung kann hergestellt werden, wenn die entsprechende Zeile mit zwei oder mehreren Leerzeichen beendet wird.

Headers - Kopfzeilen

Man unterscheidet zwei verschiedene Arten von Kopfzeilen- Formatierungen.

ATX Formatierungen für Kopfzeilen

Die Formatierung erfolgt durch Einfügen von Rautenzeichen innerhalb der Ebenen 1-6. Die erste Ebene erhält ein Rautenzeichen, die zweite Ebene erhält zwei Rautenzeichen usw. Diese einzelnen Ebenen können mit der gleichen Anzahl der Rautenzeichen geschlossen werden, dies ist allerdings nicht zwingend erforderlich.

SETEXT Formatierungen für Kopfzeilen

Die Formatierung erfolgt durch Unterstreichen der Überschriften, innerhalb der einzelnen Ebenen. Die Überschrift der ersten Ebene wird mit einem Gleichheitszeichen, die Überschrift der zweiten Ebene wird mit einem Bindestrich unterstrichen.

Zitate formatieren

Zitate werden einfach erstellt, indem ein > Zeichen vor jede umgebrochene Zeile setzt. Verschachtelte Zitate, stellen ein sogenanntes "Zitat im Zitat" dar und werden durch weitere > Zeicheneinfügung formatiert.

Lists - Listen

Markdown Syntax verarbeitet sortierte Listeneinträge (Aufzählung durch Nummerierung), sowie auch unsortierte Listeneinträge (Auflistung durch Aufzählung). Unsortierte Listen verwenden Marker wie Bindestriche, Sternchen und Pluszeichen. Bei sortierten Listeneinträgen wird vor jede Zahl ein Punkt gesetzt. Die Zahlenfolge spielt keine Rolle, das System erkennt die letzte Liste und erstellt daraus den HTML-Code.

Einrücken von Listen

Die einzelnen Beiträge können eingerückt werden, damit die Gesamterscheinung des Textbildes eine harmonische Darstellung erzeugt. Die Formatierung kann durch Leerzeichen vorgenommen werden. Das Programm wird nun automatisch diese Formatierung mit den Zeichen und, öffnen, bzw. wieder schließen.
Die Listenpunkte oder Listenabschnitte müssen genauen Grundregeln folgen. Jeder Absatz eines Listenpunkts muss mit mindestens vier Leerzeichen und einem Tab gekennzeichnet sein, damit Markdown die Formatierung akzeptiert. Es können innerhalb der Listen auch Zitate und Code-Blöcke eingerückt werden.

Code Blocks - Code Blöcke für Markup und Quelltexte

Code-Blöcke sind vorformatiert und dienen der Quelltexterstellung.

Einrücken in eine Liste

Die Code Blöcke können mit folgender Formatierung in eine beliebige Liste eingerückt werden. Die erforderliche, doppelte Einrückung, erfolgt durch 8 Leerzeichen oder durch die Eingabe von zwei Tabs. Durch die Tags pre und code, können zwei unterschiedliche Code-Blöcke verwendet werden.

Code Blöcke erstellen

Jede Zeile eines Blocks wird durch die Eingabe von vier Leerzeichen oder einem Tab, separat eingerückt. Ein Codeblock endet immer an der nächsten nicht eingerückten Zeile oder am Textende.

Umwandlung des kaufmännischen UND, sowie der Winkelklammer

Die Umwandlung in einen HTML Code erfolgt automatisch, hierzu muss lediglich das HTML in das Dokument eingefügt und eingerückt werden.

Horizontal Rules - Horizontale Linien formatieren

Die Linien werden erzeugt, indem mindestens 3 oder mehr Zeichen in aufeinanderfolgender Reihenfolge eingegeben werden. Hierzu dienen Sterne oder Striche, Leerzeichen sind ebenso erlaubt.

Span Elements - Links - Inline und Referenzen

Mit dem Öffnen und Schließen einer eckigen Klammer wird ein Link markiert.

Inline Links

Nach der geschlossenen, eckigen Klammer wird eine weitere, herkömmliche Klammer angeschlossen, in diese die URL hineingeschrieben wird. Durch relative Pfade kann auf Inhalte, die auf dem gleichen Server platziert sind, hingewiesen werden.

Referenzen

Referenz Links enthalten eine weitere Eckige Klammer, die an die Erste eckige Klammer angeschlossen ist. In der zweiten Klammer wird eine beliebige Bezeichnung für die erste Klammer eingetragen. Zwischen den beiden Klammern, kann der User auch wahlweise ein Leerzeichen stehen lassen.

Aufbau eines Links: Eckige Klammern (Einrückung mit maximal drei Leerzeichen), Doppelpunkt, Tabs (ein oder mehrere Leerzeichen), URL, evtl. Klammern mit doppelten Anführungsstrichen für Titelattribute.

Emphasis - die Betonung

Markdown Syntax behandelt Betonungen mit Sternchen oder Unterstrichen geöffnet und geschlossen. Zum Öffnungs- und Schließungsvorgang muss jeweils das gleiche Zeichen gewählt werden.

Betonungen mitten im Wort

Betonungen in Mitten eines Wortes, werden mit einem Backslash, zusätzlich zu der Zeichensetzung, eingebettet.

Code

Um Codes sichtbar zu machen, werden diese mit dem Backticks- Zeichen umgeben. Die Codes werden innerhalb eines Code-Bereichs eines Absatzes formatiert.
Ein Code Bereich, der mit Backticks umschlossen ist, kann Leerzeichen enthalten. Die Verwendung von Backticks ist am Anfang und am Ende eines Code Bereichs möglich.

Backticks innerhalb eines Codebereichs

Das kaufmännische UND, sowie die Winkelklammer werden durch Backticks markiert.

Images - Grafiken einbinden

Inline Syntax Aufbau: Ausrufezeichen, eckige Klammern (enthalten den Wert des alt- Attributes), runde Klammern (enthalten die URL, den Pfad), Anführungsstriche innerhalb dieser wird der Wert des optionalen title- Attributes angegeben.

Bild-Referenzen

Bildreferenzen werden auf die gleiche Weise, wie Link-Referenzen eingefügt.

Zu beachten:
Die Größe einer Grafik kann nicht angegeben werden, sollte dies erforderlich sein, sollte der User ein img Tag verwenden. Bei E-Mails wird gleichermaßen vorgegangen, das System verändert die Adresse nach Zufallsprinzip in dezimale und hexadezimale.

Backslash Escapes - Backslash Maskierungen

Zeichen, denen im Syntax eine Bedeutung zugeschrieben wurde, können auch ohne diese Bedeutung aufgeführt werden. Es kann "sich selbst bedeutend" eingesetzt werden, indem man Backslashs anstatt des HTML Tags em einsetzen.

Automatic Links

Automatisch erstellte Verlinkungen werden definiert, wenn die URL oder der Link mit Winkelklammern umgeben wird.