AA_simple_coonvisum_123rf_24883083.jpg

© Convisum, 123RF

Mit dem Editor Utext Markdown-Dokumente bearbeiten

Echt einfach

Einfache Formatierungen für Wikis oder HTML-Seiten erzeugen Sie am schnellsten mit Markdown. Der Editor Utext hilft Ihnen unter Ubuntu und dessen Ablegern beim Erstellen und Bearbeiten solcher Texte.

Ein Text mag für Menschen rein durch die Buchstaben einen Sinn ergeben, aber eine Maschine braucht ein paar Hinweise in Bezug auf Bedeutung und Struktur. Diese Hilfe übernehmen Formatierungen. So heben Sie unter Umständen besonders wichtige Passagen kursiv hervor, formatieren also inhaltlich, oder kennzeichnen Überschriften oder Code-Fragmente als solche, womit Sie die Struktur verdeutlichen.

Dafür hat sich der Begriff des "Auszeichnens" (englisch: Markup) eingebürgert. Zu Zeiten des Buchdrucks von Hand war das ein separater Arbeitsschritt, der Spezialisten vorbehalten war; heute übernimmt diesen Schritt der Autor, oft mithilfe einer Vorlage (Template).

Zu den bekanntesten Auszeichnungssprachen zählt (X)HTML. Es erlaubt nur eine begrenzte Menge an Formatierungen, was oft zu komplizierten Hilfskonstruktionen führt. Für Menschen fallen entsprechende Texte oft unleserlich aus. Es lag also nahe, eine Metasprache zu entwickeln, die einfacher aussieht und aus der ein Konverter direkt HTML erzeugt. Mittlerweile existiert eine ganze Reihe von Ansätzen mit diesem Ziel, darunter AsciiDoc [1], Pandoc [2] oder eben Markdown [3].

Die derzeit aktuelle Version 1.0.1 von Markdown wurde mit dem Ziel der leichten Lesbarkeit für Menschen konzipiert und beschränkt sich dementsprechend auf eine einfache Syntax. Das erreichen die Entwickler auf zweierlei Weise: Zum einen unterstützt Markdown nur eine Teilmenge der von HTML gebotenen Strukturen, zum anderen achteten die Entwickler strikt auf eine leichtverständliche Markdown-Syntax. Diese kommt heute in vielerlei Weise für das Gestalten von HTML-Seiten zum Einsatz, etwa bei Wikis. Dort steht unter Umständen kein reines Markdown bereit, sondern häufig ein Derivat, oft mit erweiterten Funktionen.

Zu den Besonderheit von Markdown zählt die Tatsache, dass Sie bei Bedarf HTML-Strukturen direkt in den Code schreiben dürfen ("Inline HTML"), ohne dass Sie dies besonders zu kennzeichnen brauchen. Auf diese Weise lassen sich selbst komplexe Strukturen verwirklichen, allerdings naturgemäß zulasten der Lesbarkeit. Ein typisches Beispiel dafür sind Tabellen, die Markdown nicht direkt unterstützt.

Für Überschriften verschiedener Ebenen bedient sich Markdown einer ähnlichen Syntax wie AsciiDoc: Zum einen erzeugen Sie diese durch Unterstreichungen, zum anderen durch Voranstellen von Gleichheitszeichen oder Doppelkreuzen ("Hashmarks"). Dabei unterstützt die Software bis zu drei Ebenen. Ein entsprechendes Beispiel zeigt Listing 1. In dieser Variante dürfen zusätzlich abschließende Zeichen auftreten.

Listing 1

Eine Überschrift
================
# Eine Überschrift
# Eine Überschrift #

Bei den einfachen Listen gibt sich Markdown ebenfalls genügsam: Ein Sternchen (*) am Zeilenanfang leitet einen Listenpunkt Liste ein. Neben dem Sternchen dürfen Sie Plus- und Minuszeichen in der gleichen Funktion einsetzen. Mit mindestens vier Leerzeichen am Zeilenanfang, gefolgt vom Zeichen für einen Listenpunkt, markieren Sie Unterpunkte. Dabei dürfen Sie unterschiedliche Zeichen in einer Ebene kombinieren: Es zählt nur die Position im Quelltext, die definiert, wie der Eintrag erscheint, nicht aber das verwendete Zeichen (Listing 2).

Listing 2

* Listeneintrag 1
+ Listeneintrag 2 (gleichen Liste und Ebene)
    - ein Unterpunkt ...
    + ... und noch ein zweiter

Aufzählungen – also nummerierte Listen – erzeugen Sie mit einer (beliebigen) Zahl oder Ziffer direkt am Zeilenanfang, der ein Punkt folgt (Listing 3). Hier gibt es wieder mit mindestens vier Leerzeichen am Zeilenanfang die Möglichkeit, verschachtelte Listen zu erzeugen. Am besten starten Sie Aufzählungen mit 1., für den Fall, dass die verwendete Software Startwerte unterstützt.

Listing 3

1. erster Punkt der Aufzählung
1. zweiter Punkt der Aufzählung
     1. erster Unterpunkt zu Punkt 2
     1. zweiter Unterpunkt zu Punkt 2
1. dritter Punkt der Aufzählung

TIPP

Möchten Sie eine Ziffer oder Zahl mit einem Punkt kombinieren, ohne eine Liste zu beginnen, maskieren Sie den Punkt mit einem Backslash (\.).

Sie erzeugen harte Umbrüche in Zeilen, indem Sie zwei Leerzeichen am Zeilenende hinzufügen. Markdown-Editoren wie Utext erkennen diese eigentlich unsichtbaren Strukturen und zeigen sie hervorgehoben an. In diesem Zusammenhang ist die Behandlung von Zeichen wie <" (Kleiner-Zeichen) und & (Ampersand) interessant: Je nach Einsatz in URLs ist es erforderlich, diese zu maskieren. Markdown erlaubt nun, diese Zeichen ohne besonderes Maskieren im Text einzusetzen.

Bemerkenswert ist die Fähigkeit von Markdown, Zitate im Stil einer E-Mail einzufügen: Es genügt, einer Zeile ein Größer-Zeichen (>) voranzustellen, um sie als Zitat kenntlich zu machen; ein auf das Größer-Zeichen folgendes Leerzeichen ist nicht erforderlich.

Bei längeren Absätzen reicht es aus, einmal ein Größer-Zeichen voranzustellen, um den gesamten Absatz als Zitat zu kennzeichnen. Das gilt selbst dann, wenn der Absatz harte Umbrüche enthält. Verschachtelte Zitate realisieren Sie durch mehrere Größer-Zeichen (Listing 4).

Listing 4

>Bemerkenswert ist auch die Möglichkeiten, Zitate (im
 E-Mail-Stil) einzufügen. Es genügt, einer Zeile ein
 >> Größer-Zeichen (>) voranzustellen, schon wird
   die Zeile als Zitat erkannt; nicht einmal ein
    folgendes Leerzeichen ist erforderlich.

Daneben bietet Markdown auch eine Möglichkeit, Quellcode zu Kennzeichnen: Dafür leiten Sie eine Zeile mit mindestens acht Leerzeichen oder zwei Tabulatoren ein. Alles, was dann folgt, interpretiert die Software als Code; Formatierungen wertet sie in dem Textblock dann nicht mehr aus.

In Sachen Hypertext-Verweisen unterstützt Markdown zwei Arten von Links: Inline-Links und Referenzen. Der anklickbare Text steht bei beiden zwischen eckigen Klammern. Diesem folgen runde Klammern, in denen die URL sowie zwischen doppelten Hochkommas der Link-Titel steht. Die URL darf dabei in Form eines relativen Pfads auf lokale Dateien zeigen. Ein Inline-Link sieht dann aus wie in der ersten Zeile von Listing 5.

Bei Referenzen kommt ein weiteres Paar eckiger Klammern hinzu, das einen Bezeichner für den Link enthält, einen sogenannten Identifier (Listing 5, Zeile 2). In dieser Form des Verweises erfolgt die Definition der Referenz an einer beliebigen anderen Stelle im Dokument. Dazu fügen Sie – meist am Ende des Dokuments – eine Zeile wie in Listing 5, Zeile 3 ein.

Weitere Alternativen für diese Verweise finden Sie online [3]. Die IDs dürfen aus Buchstaben (ohne Umlaute und das "ß") sowie Ziffern, Leerzeichen und Interpunktionszeichen bestehen. Dabei ignoriert die Software die Groß- und Kleinschreibung. Ein Sonderfall stellen leere IDs dar (Listing 5, Zeile 4): In diesem Fall dient der anklickbare Text gleichzeitig als ID.

Listing 5

[anklickbarer Text](URL "Link-Titel")
[anklickbarer Text][ID]
[ID]: URL "Link-Titel"
[anklickbarer Text][]

Horizontale Linien trennen bestimmte Teile im Dokument voneinander ab und entstehen in HTML über das Element <hr />. Bei Markdown genügen drei Sternchen, Punkte oder Minus-Zeichen in einer ansonsten leeren Zeile, um diese Struktur zu erzeugen; Leerzeichen dazwischen sind dabei zulässig. Die Beispiele aus Listing 6 erzeugen alle dasselbe Ergebnis.

Listing 6

***
* * *
---
- - - - - -
...

Utext im Einsatz

Die Idee von Markdown – Klartext mit sparsamem Markup – macht es eigentlich kaum notwendig, spezielle Editoren zum Erstellen der Texte zu verwenden. Trotzdem bieten diese einige echte Vorteile, wie Utext [4] zeigt. Der Editor besteht im Wesentlichen aus zwei Fenstern (Abbildung 1): Links geben Sie den Quelltext ein, rechts erscheint das Ergebnis, sogar bei eingebettetem HTML-Code. Damit hebt sich die Software von vielen anderen Editoren ab und eignet sich nicht nur zum Eingeben und Bearbeiten von Markdown-Quelltexten, sondern auch als Lernprogramm für die Auszeichnungssprache.

Abbildung 1: Schlicht, aufgeräumt und funktionell präsentiert sich Utext.

Das Markdown-Format ist einfach, dasselbe gilt für die Arbeit mit Utext: Der Editor stellt alle Standardfunktionen bereit, aber nicht viel mehr. So bleibt die ganze Angelegenheit übersichtlich und einfach. Die Werkzeugleiste enthält nichts Überraschendes, sodass sich ein Blick auf die Menüs lohnt. Unter File finden Sie als Besonderheit eine Möglichkeit, Dateien direkt aus Dropbox – und nur dieser Cloud – zu laden beziehungsweise dorthin zu schreiben.

Im Menü View findet sich die Funktion Html. Sie schaltet das rechts angeordnete Vorschaufenster explizit in den HTML-Code-Modus um. Nutzen Sie diese Funktion, falls die Vorschau einmal nicht das erwartete Ergebnis zeigt. Auf diese Weise können Sie prüfen, ob der entsprechende Code fehlerhaft ist oder lediglich die Vorschau nicht richtig funktioniert.

Im Menü Edit gibt es die Preferences, also die Einstellungen. Über die Punkte Search und Format stoßen Sie die entsprechenden Funktionen an, wobei Letzterer erlaubt, die wichtigsten Markdown-Strukturen direkt in den Quelltext einzufügen. Im Menü Insert finden Sie Funktionen zur Integration einiger erweiterter Strukturen, etwa von horizontalen Linien, Bildern und URLs.

Beim Einfügen von Bildern öffnet sich zunächst ein Dialog für die Eingabe der relevanten HTML-Elemente (Abbildung 2). Anschließend finden Sie diese in der Vorschau wieder, aber nicht in Form der Grafik, sondern als Alternativtext (Abbildung 3). Das Kontextmenü zeigt allerdings, dass die Software das Bild tatsächlich eingebunden hat. Schneller klappt das direkte manuelle Einbinden von Bildern, die Syntax dazu gestaltet sich simpel (Listing 7, erste Zeile). Dabei dürfen Sie optional auch einen Bildtitel angeben (zweite Zeile).

Abbildung 2: Beim Einfügen von Bildern geben Sie die relevanten HTML-Elemente in einem separaten Dialog ein.
Abbildung 3: Die Vorschau zeigt zwar nicht das Bild an, aber den Verweis darauf.

Listing 7

![Alternativtext](/Pfad/zum/Bild.jpg)
![Alternativtext](/Pfad/zum/Bild.jpg) "Optionaler Titel"

Unter dem Menüpunkt Tools lässt sich eine Rechtschreibprüfung aktivieren. Als Sprache wählt Utext automatisch diejenige, die Sie für das System vorgegeben haben. Eine Möglichkeit, die Sprache umzuschalten, finden Sie bei Bedarf im Kontextmenü unter Sprachen (Abbildung 4).

Abbildung 4: Die Möglichkeit zum Umschalten der Sprachvorgaben für den Text finden sich – etwas versteckt – im Kontextmenü.

Viele Funktionen rufen Sie bei Bedarf direkt über Tastenkürzel auf, was meistens deutlich schneller gelingt, als sie im Menü zu suchen. Die Tabelle "Wichtige Tastenkürzel" fasst die gängigsten Kombinationen zusammen.

Die Konfiguration der Software fällt relativ leicht: Abbildung 5 zeigt die drei Dialoge, die das ermöglichen. Weitergehende Einstellungen – wie etwa die Möglichkeit, eigene Tastenkürzel zu verwenden – unterstützt das Programm derzeit nicht.

Abbildung 5: Die Konfiguration des Markdown-Editors erfolgt in drei Dialogen.

Wichtige Tastenkürzel

Kürzel Funktion
Formatierung
[Strg]+[1..6] Überschrift Ebene 1 bis 6
[Strg]+[-] Hochstellen
[Strg]+[+] Tiefstellen
[Strg]+[B] Fett
[Strg]+[D] Durchstreichen
[Strg]+[H] Horizontale Linie
[Strg]+[I] Kursiv
[Strg]+[Umschalt]+[I] Bild einfügen
[Strg]+[T] Zeitmarke
[Strg]+[U] Unterstreichen
[Strg]+[Umschalt]+[U] URL einfügen
[Strg]+[Umschalt]+[V] HTML
Kopieren und Suchen
[Strg]+[A] Alles auswählen
[Strg]+[C] Copy
[Strg]+[F] Suchen
[Strg]+[R] Ersetzen
[Strg]+[V] Paste
[Strg]+[X] Ausschneiden
[Strg]+[Y] Redo
[Strg]+[Z] Undo
Dateibehandlung
[Strg]+[N] Neues Dokument
[Strg]+[O] Dokument öffnen
[Strg]+[S] Speichern
[Strg]+[Umschalt]+[S] Speichern als

Fazit

Perfekt fällt die Umsetzung der Markdown-Syntax durch Utext noch nicht aus, wie ein entsprechender Test [5] ans Licht bringt. Als problematisch erweisen sich die Implementation der Kursiv-fett-Schrift durch drei Unterstriche und die horizontale Linie. Da aber sonst fast alles sehr gut funktioniert, stellt Utext eine echte Bereicherung für jeden Anwender dar, der sich mit Markdown auseinandersetzt. Die Gegenüberstellung von Quelltext und formatierter Ausgabe wirkt zweckmäßig und gut gelungen. 

Utext installieren

Am einfachsten installieren Sie Utext unter Ubuntu und dessen Derivaten aus dem entsprechenden PPA der Entwickler. Die dazu notwendigen Befehle zeigt Listing 8.

Listing 8

$ sudo add-apt-repository ppa:atareao/utext
$ sudo apt-get update
$ sudo apt-get install utext

Infos

[1] AsciiDoc: Karsten Günther, "Aus einer Quelle", LU 01/2015, S. 14, http://www.linux-community.de/33893

[2] Pandoc: Andreas Bohle, "Flott durchgereicht", LU 12/2010, S. 66, http://www.linux-community.de/21327

[3] Markdown-Syntax: http://markdown.de/syntax/

[4] Utext: http://www.atareao.es/tag/utext/

[5] Testsuite: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip

Diesen Artikel als PDF kaufen

Express-Kauf als PDF

Umfang: 5 Heftseiten

Preis € 0,99
(inkl. 19% MwSt.)

LinuxCommunity kaufen

Einzelne Ausgabe
 
Abonnements
 
TABLET & SMARTPHONE APPS
Bald erhältlich
Get it on Google Play

Deutschland

Ähnliche Artikel

Kommentare

Infos zur Publikation

LU 12/2017: Perfekte Videos

Digitale Ausgabe: Preis € 5,95
(inkl. 19% MwSt.)

LinuxUser erscheint monatlich und kostet 5,95 Euro (mit DVD 8,50 Euro). Weitere Infos zum Heft finden Sie auf der Homepage.

Das Jahresabo kostet ab 86,70 Euro. Details dazu finden Sie im Computec-Shop. Im Probeabo erhalten Sie zudem drei Ausgaben zum reduzierten Preis.

Bei Google Play finden Sie digitale Ausgaben für Tablet & Smartphone.

HINWEIS ZU PAYPAL: Die Zahlung ist ohne eigenes Paypal-Konto ganz einfach per Kreditkarte oder Lastschrift möglich!

Stellenmarkt

Aktuelle Fragen

Broadcom Adapter 802.11n nachinstallieren
Thomas Mengel, 31.10.2017 20:06, 2 Antworten
Hallo, kann man nachträglich auf einer Liveversion, MX Linux auf einem USB-Stick, nachträglich...
RUN fsck Manually / Stromausfall
Arno Krug, 29.10.2017 12:51, 1 Antworten
Hallo, nach Absturz des Rechners aufgrund fehlendem Stroms startet Linux nicht mehr wie gewohn...
source.list öffnet sich nicht
sebastian reimann, 27.10.2017 09:32, 2 Antworten
hallo Zusammen Ich habe das problem Das ich meine source.list nicht öffnen kann weiß vlt jemman...
Lieber Linux oder Windows- Betriebssystem?
Sina Kaul, 13.10.2017 16:17, 6 Antworten
Hallo, bis jetzt hatte ich immer nur mit
IT-Kurse
Alice Trader, 26.09.2017 11:35, 2 Antworten
Hallo liebe Community, ich brauche Hilfe und bin sehr verzweifelt. Ih bin noch sehr neu in eure...