reStructuredText¶
Hier folgen abschließend noch die Meta-Infos zur Dokumentenversionspflege mit Hilfe von restructuredText:
restructuredText auf Wikipedia¶
Kurzinfo auf Wikipedia zu rST
reStructuredText (kurz ReST, reST oder RST) ist eine vereinfachte Auszeichnungssprache (Markup) mit dem Ziel, in der reinen Textform besonders lesbar zu sein.
Die reST-Dokumenten lassen sich nahezu beliebig in gewünschte Formate wandeln:
ODT - OASIS Open Document Format for Office Applications (ODF)
Textformate wie für LibreOffice, Microsoft Word
HTML - diverse HTML-Varianten (Websitestile)
LaTex - professioneller Schriftsatz mit Exportmöglichkeiten nach PostScript und PDF
PDF (bzw. PostScript)
Epub - Standard für eBooks
Desweiteren lassen sich die Dokumente
professionell verlinken (taggen)
indizieren und
durchsuchen.
Eine gute Analyse und Darstellung kann man den folgenden Ausführungen der iX entnehmen.
Die folgende Abbildung zeigt den Zusammenhang zwischen der Flexibilität und der Komplexität ausgewählter (normaler und vereinfachter) Auszeichnungssprachen.
Mit Markdown am unteren Ende (sehr beschränkter Funktionsumfang, dafür sehr einfach) und LaTeX am oberen Ende der Skala (quasi unbeschränkter Funktionsumfang, aber relativ schwerfällig) stellen sich AsciiDoc und reStructuredText als guter Kompromiss heraus.
—Softwareprojekte konsistent mit Antora dokumentieren / 28.10.2024 Christian Heitzmann - Link Beitrag auf iX
Während AsciiDoc alle Ansprüche an eine vereinfachte Allzweckauszeichnungssprache erfüllt, ist reStructuredText eher in der Python-Welt oder bei den TYPO3-Entwicklern (Anm.: PHP) zu Hause.
Die im iX-Beitrag verwendete Übersichtsgrafik findet man im Original unter https://www.simplexacode.ch/articles/it_spektrum_2023_4___auszeichnungssprachen.pdf.
iX / Softwareprojekte konsistent mit Antora dokumentieren / 28.10.2024 Christian Heitzmann¶
reStructuredText ist als Sprache und mit seinem Standarddokumentationsgenerator Sphinx – quasi das Analog zu Antora für AsciiDoc – schon mehr an Technikaffine gerichtet. Anm.: Super! ich bin technikaffin ;-)