Zum Inhalt springen

reStructuredText

aus Wikipedia, der freien Enzyklopädie

Vorlage:Hinweisbaustein

{{#if:| {{#if:reStructuredText logo| {{#if:| {{#if:text/x-rst| {{#if:| {{#if:David Goodger| {{#if:2002-04-02| {{#ifeq: | KEINE_ANGABE || {{#if: | {{#if:Vereinfachte Auszeichnungssprache| {{#if:| {{#if:| {{#if:| {{#if:| {{#if:| {{#if: https://docutils.sourceforge.io/rst.html |
{{#if: reStructuredText | reStructuredText | {{#invoke:WLink|getArticleBase}} }}

}}

}}

{{#ifexist:Media:|[[Datei:|270px|]]|

{{#ifeq:0|0|}} }} {{#if:|
}} }}

Dateiendung: {{#if: trim | .rst }} | keine}}
MIME-Type: text/x-rst

}}

Magische Zahl: hex

}} {{#if:| () }} }}

Entwickelt von: David Goodger

}}

Erstveröffentlichung: Execute}}|}} | 2002-04-02 }}

}}

Aktuelle Version
() }}
 {{#if: {{#invoke:Wikidata|claim|P348|P548|!Q3295609,Q51930650,Q2122918,Q21727724,Q1072356}} |
Aktuelle Version claim|P348|P548|!Q3295609,Q51930650,Q2122918,Q21727724,Q1072356|references=ja}} {{#if: {{#invoke:Wikidata|claim|P348|P548|!Q3295609,Q51930650,Q2122918,Q21727724,Q1072356|qualifier=P577}} |
({{#invoke:Wikidata|claim|P348|P548|!Q3295609,Q51930650,Q2122918,Q21727724,Q1072356|qualifier=P577}}) }}}}}}

}}

Art: Vereinfachte Auszeichnungssprache

}}

Container für:

}}

Enthalten in:

}}

Erweitert von:

}}

Erweitert zu:

}}

Standard(s):

}}

https://docutils.sourceforge.io/rst.html |

{{#if: {{#invoke:Wikidata|claim|P856}} |

{{#invoke:WLink|formatURL| {{#invoke:Wikidata|claim|P856|parameter=link}}}}

}} }}

{{#ifeq:0|0|

{{#if:Vereinfachte Auszeichnungssprache| |}} {{#if:.rst | |}} {{#if:David Goodger| |}} {{#if:| |}} {{#if:| |}} {{#if:text/x-rst| |}} {{#if:|
}} {{#if:| |}} {{#if:https://docutils.sourceforge.io/rst.html%7C |}} }}

{{#invoke:TemplatePar|check all= opt= Name= Icon= Logo= Screenshot= Beschreibung= Dateiendung= MIME= MIME-Anm= MagischeZahl= MagischeZahlNotation= MagischeZahlHex= Entwickler= Veröffentlicht= LetzteVersion= LetzteVersionDatum= Art= Container für= Enthalten in= Erweitert von= Erweitert zu= Standard= Website= format=@@@ 0 | Wikipedia:Vorlagenfehler/Vorlage:Infobox Dateiformat}} template=Vorlage:Infobox Dateiformat

}}

reStructuredText (kurz ReST, reST oder RST) ist eine vereinfachte Auszeichnungssprache ({{#invoke:Vorlage:lang|full|CODE=en|SCRIPTING=Latn|SERVICE=englisch}}) 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

Weblinks