Zum Inhalt springen

„ReStructuredText“ – Versionsunterschied

aus Wikipedia, der freien Enzyklopädie
[gesichtete Version][gesichtete Version]
Inhalt gelöscht Inhalt hinzugefügt
Version ist von docutils und nicht von restructured Text, keine Belege, nur Primärquellen, 1 Weblink tot, 1 Weblink Spam
K Bot: Artikel hat keine Einzelnachweise, leeren Abschnitt mit <references entfernt, Dateieinbindungen: deutsche Schlüsselworte, http nach https umgestellt
Zeile 4: Zeile 4:
| Name = reStructuredText
| Name = reStructuredText
| Icon =
| Icon =
| Logo = [[Datei:ReStructuredText Logo.svg|frameless|reStructuredText logo]]
| Logo = [[Datei:ReStructuredText Logo.svg|rahmenlos|reStructuredText logo]]
| Screenshot =
| Screenshot =
| Beschreibung =
| Beschreibung =
Zeile 70: Zeile 70:
Dieser Satz dient zur Demonstration_ von `Hyperlinks in reST`_.
Dieser Satz dient zur Demonstration_ von `Hyperlinks in reST`_.


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


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


__ http://www.python.org/
__ https://www.python.org/


[[Fußnote]]n:
[[Fußnote]]n:
Zeile 89: Zeile 89:
* [http://docutils.sourceforge.net/rst.html reStructuredText]
* [http://docutils.sourceforge.net/rst.html reStructuredText]
* [http://docutils.sourceforge.net/docs/user/rst/quickref.html ReST-Kurzreferenz]
* [http://docutils.sourceforge.net/docs/user/rst/quickref.html ReST-Kurzreferenz]

== Einzelnachweise ==
<references />


[[Kategorie:Vereinfachte Auszeichnungssprache]]
[[Kategorie:Vereinfachte Auszeichnungssprache]]

Version vom 5. September 2024, 05:28 Uhr

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: http://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