8.3 Structured Text

... ist einfacher, formatierter ASCII-Text, der so aufgebaut ist, daß er die üblichen Konstrukte (Paragraphen, Spiegelstriche, ...) enthält und so vergleichsweise einfach in andere Formate (etwa in Webseiten) umgewandelt werden kann, aber trotzdem für das Bearbeiten des Rohtextes leserlich bleibt.

(Vorsicht allerdings mit eingestreuten HTML-Konstrukten. Diese werden interpretiert.)

Im Einzelnen gibt es dazu u.a. die folgenden Regeln:

• Paragraphen werden durch Leerzeilen voneinander abgegrenzt.
• wenn ein nachfolgender Paragraph stärker eingerückt ist, dann ist der Paragraph davor eine Überschrift.
• Ein Paragraph, der mit einem -, * oder einem o beginnt, definiert einen Spiegelstrich.
• "Quoten" einer Phrase mit * ergibt eine Formatierung als emphasized (EM).
• "Quoten" eines Phrase mit ** ergibt eine Formatierung als strong (STRONG).
• "Quoten" einer Phrase mit _ (Unterstrich) ergibt eine Formatierung als unterstrichen.
• "Quoten" einer Phrase mit ' (einfaches Quote) ergibt eine Formatierung als Code.
• Endet ein Paragraph mit einem doppelten Doppelpunkt ::, so gelten direkt nachfolgende Unterparagraphen als Beispieltext, der unbearbeitet dargestellt wird:

            o      (    Wolfgang.Strobl@gmd.de          (+49 2241) 14-2394
           /\        *  GMD Forschungszentrum Informationstechnik GmbH
         _`\ `_<===     Schloss Birlinghoven,           | #include
      __(_)/_(_)___.-._ D-53754 Sankt Augustin, Germany | <std.disclaimer>
  

• Links werden in der Form mit " gequoteter Text, Doppelpunkt, URL geschrieben. Ein Beispiel:

       "Zettelkasten für die FAQ von de.rec.fahrrad":http://ntklotz.gmd.de/drf/FAQ/
  

Umgekehrt kann man ihn auch dazu nutzen, Texte, die von "schreibmaschinenartigen" Medien (Usenet, News, E-Mail) stammen, ohne größere Überarbeitung ins Web zu bringen.

• Das ergibt dann Zettelkasten für die FAQ von de.rec.fahrrad
• Dasselbe kann man auch mit Mailadressen machen: Wolfgang Strobl

(Wie es wirklich ausschaut, muß man sich im Input anschauen, der Parser für StructuredText ist alles andere als perfekt)

Und so sieht das im Input aus:

/drf/faq/org/StructuredTextRaw

http://0x1a.de/rec/fahrrad/faq/org/StructuredText/index.html
Wolfgang Strobl Email: drffaq@mystrobl.de
1.1 2003-01-04