Eine RST-Datei ist eine Textdatei. RST steht dabei für reStructuredText, manchmal werden die Begrife RST, ReST, or reST gleichbedeutend und austauschbar verwendet.
RST ist aufgrund der Eigenschaften und Herkunft besonders unter Python-Programmierern verbreitet. Allgemein gesagt, soll damit die Textdarstellung vereinheitlicht werden.
Entstehung und Designziele der RST-Datei
Wie der Name reStructuredText andeutet, ist dieses Format eine Verbesserung bzw. Weiterentwicklung. Ursprünglich entwickelte die Firma Zope die Software Markup Language StructuredText, die jedoch einige bekannte Schwachstellen aufwies. David Goodger hat dann im Jahr 2002 eine Weiterentwicklung vorgestellt. Diese sollte „revised, reworked, and reinterpreted“ sein. Als Referenz darauf wurde das fertige Konstrukt „reStructured Text“ genannt.
Eine RST-Datei besteht aus darzustellendem Text wie Programmcode und einfachen Formatierungsanweisungen. Wichtig dabei: Die Datei sollte in komplexen Umgebungen funktionieren, in denen automatisiert Texte erzeugt und weiterverarbeitet werden. Dies betriff unter anderem Programmierer, die ihren Programmcode zur besseren Lesbarkeit strukturiert darstellen müssen. Hier ist dann oftmals eine weitere anschließende Bearbeitung durch spezialisierte Software nötig.
Verbreitete Formatierungsanweisungen sind beispielsweise die Aufteilung in Listen, Abschnitte, Überschriften und Darstellung von externen Links. Zur besseren Lesbarkeit lässt sich die Schrift fett und kursiv darstellen.
RST-Datei bearbeiten und öffnen
Auf Windows-PCs ist eine Datei mit reStructuredText an der Endung .rst erkennbar. Per Doppelklick starten Sie diese mit einem installierten und verknüpften Editor. Ist kein spezielles Programm für die Bearbeitung einer RST-Datei installiert, so lässt sich diese ebenso mit einem normalen Windows-Editor wie Notepad öffnen.
Eine RST-Datei wird im Regelfall von anderen Programmen erzeugt. Oft bereitet man fertige Programme automatisiert für Dokumentationszwecke auf.
Manuelles Bearbeiten einer RST-Datei bedeutet, dass man die Formatierungsanweisungen per Hand setzt und verändert. Das heißt, der Bearbeiter sieht erst später nach weiterer Verarbeitung durch Anzeigesoftware das fertige Aussehen.
Eine weitverbreitete Anwendung ist die Darstellung und Formatierung von Python-Programmen mittels des Dokumentationssystems „Sphinx“. Dies benutzt das docutils Framework für die Verarbeitung von reStructuredText.
Eine Umwandlung in andere Ausgabeformate erfolgt dann durch sogenannte Exportprogramme, die eine Umwandlung in Ausgabeformate wie MS Office oder PDF vornehmen. Eine Änderung der Dateiendung von .rst in .txt würde somit lediglich etwaige vorhandene Verknüpfungen zu installierten Bearbeitungsprogrammen zerstören, aber nicht die Datei selbst umwandeln.
Eine offizielle Liste von Software, die RST-Dateien öffnen oder weiterverarbeiten kann, findet sich beispielsweise unter https://docutils.sourceforge.io/docs/user/links.html.
Sie können RST-Dateien mit den folgenden Programmen öffnen:
Windows
- RSTTool – Discontinued
- Microsoft Notepad
- GitHub Atom
- GNU Emacs
- Any text editor
Mac
- RSTTool – Discontinued
- Apple TextEdit
- GitHub Atom
- GNU Emacs
- Any text editor
Linux
- Vim
- GitHub Atom
- GNU Emacs
- Any text editor
Mobile
Fazit zur RST-Datei
Eine RST-Datei enthält Textinhalte und menschenlesbare Formatierungsanweisungen für spätere Darstellungen. Diese Dateien werden im Regelfall von spezieller Software automatisiert weiterverarbeitet und stellen daher eine Zwischenstufe dar. Eine RST-Datei lässt sich direkt von Hand mit jedem normalen Texteditor öffnen und bearbeiten. Für Softwareentwickler gibt es dazu spezialisierte Programme, die hierbei helfen.
