ReStructuredText

reStructuredText (kurz: ReST) ist eine Auszeichnungssprache (Markup) mit dem Ziel, in der reinen Textform besonders lesbar zu sein. Weiterhin soll reStructuredText leicht in andere Formate umwandelbar sein. Die derzeitige Version (0.4) unterstützt XHTML, XML sowie LaTeX. Letzteres ermöglicht einen unkomplizierten Export nach PDF.

Der reStructuredText-Parser ist eine Komponente der Docutils, einem in der Programmiersprache Python entwickelten Textverarbeitungsprogramm. Eben in diesem Umfeld findet reStructuredText verbreitet Einsatz in der Formatierung der docstrings, der Python-typischen Kommentare zur Programmdokumentation. Zudem bieten einige Wiki-Systeme neben ihrer eigenen Wiki-Syntax reStructuredText als Alternative an.

Übliche Abkürzungen für reStructuredText sind RST, reST oder ReST.

Syntaxbeispiele

Überschriften:

Abschnitt
=========

Unterabschnitt
--------------

Aufzählungslisten:

- Erster Punkt

- Zweiter Punkt

  - Ein Unterpunkt

- Dritter Punkt

1) Ein Punkt einer nummerierten Liste

2) Zweites...

   a) Unterpunkt einer nummerierten Liste

      i) Noch eine Ebene tiefer...

3) Dritter Punkt der nummerierten Liste

Benannte Hyperlinks:

Dieser Satz dient zur Demonstration_ von `Hyperlinks in reST`_.

.. _Demonstration: http://de.wikipedia.org/wiki/Demonstration
.. _Hyperlinks in reST: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets

Anonyme Hyperlinks:

Ein Satz mit einem `anonymen Link auf die Python Website`__.

__ http://www.python.org/

Fußnoten:

Hier steht nicht viel [#]_.  Schauen sie einfach mal ans Ende der Seite.

.. [#] Fußnoten können automatisch durchnummeriert werden. Mehr dazu in der reST Kurzreferenz

Weblinks

• Docutils
• reStructuredText
• ReST-Kurzreferenz