Was ist strukturierter Text?

Dieser Text soll eine einfache Einführung in strukturierten Text bieten. Natürlich kann er kein Ersatz für die offizielle Anleitung sein, aber immerhin einen groben Überblick was davon implementiert ist sollte hier gegeben werden. Jutta hat im Hexentanz auch eine Anleitung.

Grundsätzlich ist strukturierter Text ganz normaler Standard-Text. Das Besondere: es läuft ein automatischer Umwandler, der diesen Text in seinem Format interpretiert und daraus dann HTML generiert. Diese Interpretation orientiert sich an der textuellen Struktur, man muss also einfach nur grob vorformatierten Text schreiben, der Rest passiert von alleine.

Folgende Features unterstützt die Integration von Docutils und Structured Text im Python Desktop Server:

Absatztypen (normale, eingerückte, vorformatierte)
Aufzählungen (normale, numerierte, mit Buchstaben, etc.)
schrägschrift und fettdruck
automatisches Umsetzen von Links (mail und web)
Überschriften (wobei das eher weniger nötig ist, da Stories ja eigene Titel haben, genau wie Postings)
Definitionslisten
einfache Zuweisungstabellen
einfache Verlinkung innerhalb des Dokumentes
einfache externe Links wie dieser auf die Python Homepage
auch anonyme Links wie dieser auf meine Homepage funktionieren

Unbekannte StructuredText-Ausdrücke werden automatisch ausgefiltert und eventuell enthaltene Elemente, die bekannt sind, übernommen. Das kann allerdings mal schief gehen.

Makros und Makrosprachenausdrücke funktionieren auch, da zuerst die StructuredText-Wandlung eingesetzt wird und dann auf den Output davon der CheetaTemplate-Prozessor. Wenn es mit Makroausdrücken Probleme gibt, muss man das mit Backticks kapseln. Das ist zum Beispiel bei Makroaufrufen mit URLs drin der Fall: Docutils würde diese in Links umwandeln und damit den Source kaputt machen. Also einfach mit ` klammern.

Alles in allem wird sich erst noch zeigen müssen, ob strukturierter Text wirklich eine Alternative darstellt, aber bequemer als dauernd spitze Klammern zu benutzen ist es allemal.

Als Beispiel kommt hier der Source dieser Story, da sieht man schon mal ein paar der Features angewendet:

Dieser Text soll eine einfache Einführung in strukturierten Text bieten. Natürlich kann er kein Ersatz für die `$macros.linkTag('http://docutils.sourceforge.net/docs/rst/quickref.html', 'offizielle Anleitung')` sein, aber immerhin einen groben Überblick was davon implementiert ist sollte hier gegeben werden. Jutta hat im Hexentanz auch eine Anleitung_.

Folgende Features unterstützt die Integration von Docutils und Structured Text im "PyDS":

- Absatztypen (normale, eingerückte, vorformatierte)
- Aufzählungen (normale, numerierte, mit Buchstaben, etc.)
- *schrägschrift* und **fettdruck**
- automatisches Umsetzen von Links (mail und web)
- Überschriften (wobei das eher weniger nötig ist, da Stories ja eigene Titel haben, genau wie Postings)
- Definitionslisten
- einfache Zuweisungstabellen
- einfache Verlinkung innerhalb des Dokumentes
- einfache externe Links wie dieser auf die `Python Homepage`_
- auch anonyme Links wie dieser auf `meine Homepage`__ funktionieren

.. note:: Unbekannte StructuredText-Ausdrücke werden automatisch ausgefiltert und eventuell enthaltene Elemente, die bekannt sind, übernommen. Das kann allerdings mal schief gehen.

Alles in allem wird sich erst noch zeigen müssen, ob strukturierter Text wirklich eine Alternative darstellt, aber bequemer als dauernd spitze Klammern zu benutzen ist es allemal.

Als Beispiel kommt hier der Source dieser Story, da sieht man schon mal ein paar der Features angewendet:

$macros.quotedStorySource(8)

.. _Python Homepage: http://www.python.org/
.. _Anleitung: http://witch.muensterland.org/stories/9.html

.. __: http://hugo.muensterland.org/