So gehts: Strukturierter Text

  • Send this page to somebody
  • Print this page
Eine kurze Anleitung für das Eingeben von klassischem Strukturiertem Text (Original von Peter Funk)

Regeln Text lesbarer zu formatieren

Strukturierter Text ist eigentlich normaler gewöhnlicher Text, der mit den folgenden einfachen Regeln besser lesbar formatiert ausgegeben wird. Dazu werden Einrückungen, Zeilenumbrüche und einige Sonderzeichen ausgewertet, um die Formatierung des Textes bestimmen:

  • Absätze immer mit Leerzeilen trennen (das ist sehr wichtig!)
  • um ein oder mehrere Worte kursiv darzustellen, müssen diese in einfache Sterne eingeschlossen werden.
  • doppelte Sterne vor und nach den Worten und Textteilen bewirken, dass diese fett dargestellt werden.
  • Beginne Absätze mit '-', * oder o um Aufzählungsmarken zu erzeugen
  • benutze eine Zahl gefolgt von einem Leerzeichen um eine nummerierte Liste zu erzeugen

Beispiele:

  1. Überschriften: Um eine Überschrift zu erzeugen, schreibe den Text gefolgt von einer Leerzeile. Das erste Word des folgenden Absatz mit einem Leerzeichen einrücken.
  2. Kursiv und Fett: Um kursives wie dieses zu erzeugen die Wörter mit Sternen umschliessen. Um es Fett darzustellen wie dieses, umschliessen mit Doppelsternen.
  3. Unterstreichen: Umschliessen des Wortes oder Satzteil mit _ (Tiefstrich).
  4. Eine Liste anfertigen: hinter jedem Listeneintrag eine Leerzeile einfügen, am Zeilenanfanfang einleiten mit - * oder o.
  5. Einen Link angeben: Den Teil der angezeigt werden soll in Anführungszeichen angeben, gefo lgt von einem Doppelpunkt und der Adresse z.B. https://dzug.org/ und einem Leerzeichen. Dabei können auch relative Links angegeben werden.
  6. Ein Bild einfügen: Das geht genauso wie bei einem Link, nur das der in Anführungszeichen eingeschlossene Text von :img: und der Adresse des Bildes gefolgt wird.

Anmerkung: Eine Leerzeile am Ende eines Eintrags und ein Leerzeichen als letztes erzeugt eine Überschrift

Nochmal ausführlich

Strukturierter Text ist Text, der Ausrichtung und einfache Symbolik nutzt, um die Struktur eines Dokuments auszuzeichnen.

Ein strukturierter Text besteht aus einer Folge von Absätzen, getrennt durch eine oder mehrere Zeilen. Die Gliederung des Textes in Abschnitte und Unterabschnitte wird durch die jeweils kleinste Einrückung dieser Absätze bestimmt. Ein Absatz wird zum Unterabsatz eines Anderen, wenn der andere Absatz der letzte vorhergehende Absatz mit einer geringeren Einrückung ist.

Folgende Symbolik wird zur Auszeichnung spezieller Konstrukte benutzt:

  • ein einzeiliger Absatz, gefolgt von einem weiter nach rechts eingerückten Absatz, ist eine Überschrift
  • ein Absatz, der mit -,* oder o gefolgt von mindestens einem Leerzeichen beginnt, ist Element einer Liste von Anstrichen
  • ein Absatz, der mit einer Folge von Ziffern gefolgt von einem Leerzeichen beginnt, ist Element einer nummerierten Liste
  • ein Absatz, der mit einer Folge von Folgen, die jeweils Ziffern oder von einem Punkt gefolgten Buchstaben sind, ist element einer nummerierten/geordneten Liste
  • ein Absatz, dessen erste Zeile Texte gefolgt von mindestens einem Leerzeichen und -- enthält ist eine erklärende/beschreibende Liste. Hierbei ist der führende Text das beschriebende Element
  • Unterabsätze, die mit dem Wort example oder examples oder :: enden, werden als Beispielcode betrachtet und wie folgt ausgegeben

    Text::

  • in einfache Anführungszeichen eingeschlossener (und mit mindestens einem Leerzeichen links des ersten Anführungszeichens und mindestens einem Leerzeichen oder mindestens einem Punkt rechts des zweiten Anführungszeichens begrenzter) Text wird als Beispielcode interpretiert.

Zum Beispiel: .

  • in einfache Sterne eingeschlossener (und mit mindestens einem Leerzeichen links des ersten Stern und mindestens einem Leerzeichen oder mindestens einem Punkt rechts des zweiten Stern begrenzter) Text wird kursiv dargestellt.
  • in Doppelsterne eingeschlossener (und mit mindestens einem Leerzeichen links des ersten Doppelstern und mindestens einem Leerzeichen oder mindestens einem Punkt rechts des zweiten Doppelstern begrenzter) Text wird fett dargestellt.
  • in Unterstriche _ eingeschlossener (und mit mindestens einem Leerzeichen links des ersten _ und mindestens einem Leerzeichen oder mindestens einem Punkt rechts des zweiten _ begrenzter) Text wird unterstrichen dargestellt.
  • In doppelte Anführungszeichen eingeschlossener und von einem Doppelpunkt sowie einer URL und mindestens einem Leerzeichen oder mindestens einem Punkt gefolgter Text wird als Hyperlink betrachtet

Zum Beispielt wird:

    "DZUG":https://dzug.org/ 

als DZUG interpretiert oder auch:

    "mail me", mailto: 

ergibt

Anmerkung: Dies gilt sowohl für relative wie für absolute URL's

  • In eckige Klammern eingeschlossener Text, der nur aus Buchstaben, Zahlen, Unterstrichen sowie Bindestrichen (Minus) besteht, wird als Hyperlink innerhalb des Dokumentes interpretiert.

Zum Beispiel:

   '"Wie von Smith [12] beschrieben ist ..."' 

Wird ausgegeben als : "Wie von Smith [12] beschrieben ist ..."

Zusammen mit der nächsten Regeln kann man auf diese Art einfach Referenzen und Fuß;noten beschreiben.

  • die Folge von zwei Punkten, einem Leerzeichen und in eckigen Klammern eingeschlossenem Text am Beginn einer Zeile wird als benannter Link (auch Anker) interpretiert
    zum Beispiel wird:
    ! .. [12] "Effective Techniques" Smith, Joe ...
    interpretiert als

[12] "Effective Techniques" Smith, Joe ...

*Anmerkung: beachte das im HTML Quelltext.*

Created by dzugng
Last modified 09.04.2005 15:21