ReStructuredText

Dieser Artikel oder nachfolgende Abschnitt ist nicht hinreichend mit Belegen (beispielsweise Einzelnachweisen) ausgestattet. Angaben ohne ausreichenden Beleg könnten demnächst entfernt werden. Bitte hilf Wikipedia, indem du die Angaben recherchierst und gute Belege einfügst.
reStructuredText
reStructuredText logo
Dateiendung: .rst
MIME-Type: text/x-rst
Entwickelt von: David Goodger
Erstveröffentlichung: 2. April 2002
Art: Vereinfachte Auszeichnungssprache
https://docutils.sourceforge.io/rst.html


reStructuredText (kurz ReST, reST oder RST) ist eine vereinfachte Auszeichnungssprache (englisch markup language) mit dem Ziel, in der reinen Textform besonders lesbar zu sein. Weiterhin soll reStructuredText leicht in andere Formate umwandelbar sein.

Hintergrund

Der reStructuredText-Parser ist eine Komponente der Docutils, einer in der Programmiersprache Python entwickelten Textverarbeitungsbibliothek. Version 0.6 unterstützt die Umwandlung in ODT, Manpage, S5, XHTML, XML sowie LaTeX. Letzteres ermöglicht einen professionellen Schriftsatz mit Exportmöglichkeiten nach PostScript und PDF.

reStructuredText findet verbreitet Einsatz in der Formatierung der docstrings, der Python-typischen Kommentare zur Programmdokumentation. Das Software-Dokumentationswerkzeug Sphinx nutzt reStructuredText. Zudem bieten einige Wiki-Systeme neben ihrer eigenen Wiki-Syntax reStructuredText als Alternative an.

GitHub, Bitbucket und GitLab unterstützen reST.

Vergleichbare leichte Auszeichnungssprachen sind z. B. Markdown, Textile und AsciiDoc.

Syntaxbeispiele

Überschriften: 

Abschnitt
=========

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

Aufzählungslisten: 

- Erster Punkt

- Zweiter Punkt

  - Ein Unterpunkt

- Dritter Punkt



1) Ein Punkt einer nummerierten Liste

2) Zweitens...

   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: https://de.wikipedia.org/wiki/Demonstration
.. _Hyperlinks in reST: https://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets

Anonyme Hyperlinks: 

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

__ https://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

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.