Übersicht

Kommentare bestehen in reStructuredText aus verschiedenen (verschachtelten) Textkörperelementen und können in Abschnitte mit Überschriften gegliedert werden.

Beginnend mit einem einführenden Beispiel wird in den nachfolgenden Abschnitten ein Überblick über die Syntax des reStructuredText-Markups gegeben.

Im ersten Teil der Beschreibung werden dazu die wesentlichen Konzepte und die Syntax von reStructuredText vorgestellt. Im zweiten eher anwendungsorientierten Teil der Beschreibung werden verschiedene Möglichkeiten der Kommentargestaltung unter Nutzung verschiedener Syntaxelemente erläutert.

	Die richtige Verwendung der Syntax ist Voraussetzung für eine fehlerfreie Darstellung im Bibliotheksverwalter. Die dargestellten Informationen basieren auf den Inhalten der Dokutils-Dokumentation (reStructuredText Markup Spezifikation).

Beispiel	Beispiele
Allgemeine Hinweise (Syntaxelemente)	Leerzeilen und Einrückung Einfache und komplexere Markup Explizite Markup-Blöcke Direktiven Inline-Markup Escaping-Mechanismus Referenznamen
Kommentarstruktur (Kommentarstruktur)	Abschnitte Übergänge
Textblöcke (Textblöcke)	Textblock (Absatz) Eingerückter Textblock (Blockzitat) Zeilenorientierter Textblock (Zeilenblock)
Listen (Listen)	Ungeordnete Aufzählungsliste Geordnete (nummerierte) Aufzählungsliste Definitionsliste Feldliste
Tabellen (Tabellen)	Einfache Tabelle Gittertabelle CSV-Tabelle Listentabelle
Hyperlinks (Hyperlinks)	Interne Hyperlinks Externe Hyperlinks Alleinstehende Hyperlinks Eingebettete URIs und Aliases Indirekte Hyperlinks Inline-Hyperlinks Anonyme Hyperlinks Fußnoten Zitate
Substitution	Substitution
Hinweiselemente (Hinweiselemente)	Spezifische Hinweise Generische Hinweise
Bilder	Bilder
Codeblock	Codeblock
Interne Kommentare	Interne Kommentare
Schriftstil (Schriftstil)	Hervorgehobener Text (kursiv) Stark hervorgehobener Text (fett) Inline-Literale (Konstantschrift)