„ReStructuredText“ – Versionsunterschied
| [gesichtete Version] | [gesichtete Version] |
Korr. der Übersetzung |
Version ist von docutils und nicht von restructured Text, keine Belege, nur Primärquellen, 1 Weblink tot, 1 Weblink Spam |
||
| Zeile 1: | Zeile 1: | ||
{{SEITENTITEL:reStructuredText}} |
{{SEITENTITEL:reStructuredText}} |
||
{{Belege fehlen}} |
|||
{{Infobox Dateiformat |
{{Infobox Dateiformat |
||
| Name = reStructuredText |
| Name = reStructuredText |
||
| Zeile 27: | Zeile 28: | ||
== Hintergrund == |
== Hintergrund == |
||
Der reStructuredText-[[Parser]] ist eine Komponente der Docutils, einer in der [[Programmiersprache]] [[Python (Programmiersprache)|Python]] entwickelten Textverarbeitungsbibliothek. Version 0.6 unterstützt die Umwandlung in [[OpenDocument|ODT]], [[Manpage]], [[S5 (Dateiformat)|S5]], [[XHTML]], [[Extensible Markup Language|XML]] sowie [[LaTeX]]. Letzteres ermöglicht einen professionellen Schriftsatz mit Exportmöglichkeiten nach [[PostScript]] und [[PDF]]. |
Der reStructuredText-[[Parser]] ist eine Komponente der Docutils, einer in der [[Programmiersprache]] [[Python (Programmiersprache)|Python]] entwickelten Textverarbeitungsbibliothek. Version 0.6 unterstützt die Umwandlung in [[OpenDocument|ODT]], [[Manpage]], [[S5 (Dateiformat)|S5]], [[XHTML]], [[Extensible Markup Language|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 (Software)|Sphinx]] nutzt reStructuredText. Zudem bieten einige [[Wiki|Wiki-Systeme]] neben ihrer eigenen [[Wiki-Syntax]] reStructuredText als Alternative an. |
reStructuredText findet verbreitet Einsatz in der Formatierung der docstrings, der Python-typischen Kommentare zur Programmdokumentation. Das [[Software-Dokumentationswerkzeug]] [[Sphinx (Software)|Sphinx]] nutzt reStructuredText. Zudem bieten einige [[Wiki|Wiki-Systeme]] neben ihrer eigenen [[Wiki-Syntax]] reStructuredText als Alternative an. |
||
| Zeile 88: | 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] |
||
* [https://notex.ch/ NoTex – Ein Browser-basierter reStructuredText-Editor] |
|||
* [http://rst.ninjs.org/ Online reStructuredText editor] |
|||
== Einzelnachweise == |
== Einzelnachweise == |
||
Version vom 21. Juni 2024, 20:31 Uhr
| reStructuredText | |
|---|---|
| |
| 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: 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/
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