[[Vorlage(getestet, bionic)]] {{{#!vorlage Wissen [:Pakete installieren: Installation von Programmen] [:Terminal: Ein Terminal öffnen] [:mit Root-Rechten arbeiten:] [:Editor: Einen Editor öffnen] }}} [[Inhaltsverzeichnis(1)]] Die [sourceforge2:docutils:Docutils] {en} sind ein Sammlung von (Hilfs-)Programmen, mit denen Textdateien sehr einfach in HTML-Seiten, LaTeX-Dokumente, XML-Dateien und [http://meyerweb.com/eric/tools/s5/ S5-Präsentationen] {en} umgewandelt werden können. Die Quelldatei ist dabei immer die gleiche, lediglich der eingesetzte Textparser bestimmt das "Ergebnis". Die Docutils entstammen dem Python-Umfeld und sind auch komplett in [:Python:] geschrieben, aber ansonsten nicht Python-spezifisch, sondern universell einsetzbar. Als Markup-Sprache verwenden die Docutils [http://docutils.sourceforge.net/rst.html reStructuredText] {en}, eine sehr einfache Markup-Sprache, welche der Syntax eines Wikis nicht unähnlich ist. reStructuredText ist unter Python die Standard-Sprache für Dokumentationen. = Installation = Aus den offiziellen Paketquellen sind die Docutils für Python 3.x über folgendes Paket installierbar [1]: {{{#!vorlage Paketinstallation python3-docutils }}} = Manuell == Die aktuelle Version der Docutils lässt sich via [:pip:] installieren: [[Vorlage(Pipinstallation, docutils)]] = Verwendung = Prinzipiell kann man Dokumente in reStructuredText-Syntax mit jedem beliebigen Editor erstellen[4]. Es gibt aber auch spezielle Editoren wie z.B. [:ReText:], die eine Vorschau beinhalten, was insbesondere zum Erlernen der Syntax praktisch ist. Eine Einführung in die Syntax findet man in der [http://docutils.sourceforge.net/rst.html#user-documentation offiziellen Dokumentation] {en}, aufgeteilt in die Bereiche "User-Dokumentation" und "Reference Documentation". Wer es besonders eilig hat, liest die [http://docutils.sourceforge.net/docs/user/rst/quickref.html Schnellanleitung] {en}. Die Syntax erlaubt alle bekannten Elemente wie interne und externe Links, Hervorhebungen, Tabellen, Listen, Fußnoten, automatische Inhaltsverzeichnisse, Hinweisboxen, Einbinden von Bildern und vieles mehr. Im Folgenden ein kurzes, einfaches Beispiel: {{{ ==================== reStructuredText ==================== .. contents\\:\\: Inhaltsverzeichnis Abschnitt 1 ~~~~~~~~~~~~ Die *Docutils* enthalten **reStructuredText**, eine einfache Markup-Sprache, aus der von in Python geschriebenen Parsern u.a. HTML- und LaTeX-Dokumente generiert werden können. reStructuredText beherrscht: * Listen - nummeriert - unnummeriert * Tabellen * und vieles mehr Abschnitt 2 ~~~~~~~~~~~~ Außerdem gibt es Direktiven für Hinweis-Boxen, zum Einbinden von Bildern etc. Abschnitt 2A ############## Dieses Dokument ist nur ein simples Beispiel... mit einem externen Link auf die Homepage von Python_ .. _Python : http://www.python.org }}} {{{#!vorlage Hinweis In der Zeile `.. contents\\:\\: Inhaltsverzeichnis` sind die rückwärtigen Schrägstriche zu entfernen. Wegen eines Inyoka-Bugs sind diese im Quelltext enthalten. }}} Dieses Dokument kann dann unter einem beliebigen Namen gespeichert werden. Möchte man daraus eine HTML5-Datei machen, nutzt man '''rst2html5''': {{{#!vorlage Befehl rst2html5 DATEINAME AUSGABEDATEI.html }}} '''AUSGABEDATEI.html''' wird automatisch angelegt oder - falls schon vorhanden - ohne Warnung überschrieben. Der generierte HTML-Code für das obige Beispiel sieht so aus: {{{#!code html
Inhaltsverzeichnis
Die Docutils enthalten reStructuredText, eine einfache Markup-Sprache, aus der von in Python geschriebenen Parsern u.a. HTML- und LaTeX-Dokumente generiert werden können.
reStructuredText beherrscht:
Listen
nummeriert - unnummeriert
Tabellen
und vieles mehr
Außerdem gibt es Direktiven für Hinweis-Boxen, zum Einbinden von Bildern etc.
Dieses Dokument ist nur ein simples Beispiel... mit einem externen Link auf die Homepage von Python