Structured Text

Ingenieure verbringen viel Zeit mit Kommunikation, vorzugsweise per Email, aber auch über Dokumentationen. Jedoch sind Dokumentationen von Ingenieuren aus einem einfachen Grund sehr kompliziert: Die Welt konsumiert Dokumentationen hauptsächlich in Präsentationsformaten wie HTML oder PDF.

Theoretisch wäre das kein großes Problem, wenn wir alle fröhlich losmarschieren und in „DocBook“ (oder vielleicht LaTeX) schreiben, der angeblichen „lingua franca“ der Dokumentation. Allerdings unterstützen die meisten Werkzeuge „DocBook“ (oder LaTeX) nicht besonders gut, und selbst wenn die Werkzeuge komplett durchentwickelt wären, würden die meisten sie ablehnen. Warum? Ingeneure verbringen die meiste Zeit damit, mit einfachem Text zu kommunizieren. Die Werkzeuge, die sie verwenden (vi und emacs) sind textorientiert. Der größte Wortanteil ihrer Kommunikation läuft über Email. Und schließlich ist alles an Dokumentation, was man aus einem Ingenieur herausquetschen kann, eine Anzahl von Kommentarzeilen in Quellcode.

Wäre es nicht nett, wenn es ein rein textorientiertes System ohne Tags dafür gäbe, die semantische Bedeutung auszudrücken? Dieses Problem wird mit structured text angegangen. Mit structured text wird formatunabhängige Texterstellung extrem natürlich und bequem, sobald einige wenige Regeln gelernt sind. Außerdem kann structured text so erweitert werden, daß er auch fortgeschrittenen und proprietären Anforderungen genügt. (Es soll jedoch nicht verschwiegen werden, daß es auch eine Schwäche gibt: die Verwendung von Umlauten. Umlaute können bisher nicht verwendet werden. In späteren Versionen wird dieses Problem sicher behoben sein.)

Um einen ersten Eindruck davon zu bekommen, was structured text ist: Der folgende Text:

Manchmal ist die *beste* Herangehensweise an die Komplexität die Einfachheit. Ein gutes structured text-System ist:

o komfortabel

o ergiebig

wird in HTML dargestellt als:

<p>

Manchmal ist die <em>beste</em> Herangehensweise an die Komplexität die Einfachheit. Ein gutes structured text-System ist:

<ul>

<li>komfortabel

<li>ergiebig

</ul>

</p>

und wie folgendes DocBook XML:

<para>

Manchmal ist die <emphasis>beste</emphasis> Herangehensweise an die Komplexität die Einfachheit. Ein gutes structured text-System ist:

</para>

<itemizedlist>

<listitem><para>komfortabel</para></listitem>

<listitem><para>ergiebig</para></listitem>

</itemizedlist>

Tatsächlich wurde der Text dieses Artikels in structured text geschrieben. In diesem Artikel werden wir uns mit den Grundlagen von structured text beschäftigen und sehen, wie man große Texte in kleinere Abschnitte organisiert, fortgeschrittene Formatierungen macht und Metadaten verwendet.