Leerzeilen und Einrückung
Die Trennung und Verschachtelung von Textkörperelementen erfolgt in reStructuredText über folgende Gestaltungselemente:
Leerzeilen
- Leerzeilen werden in einem reStructuredText zur Trennung von Absätzen und anderen Textkörperelementen verwendet (siehe Beispiele).
- Mehrere aufeinanderfolgende Leerzeilen entsprechen einer einzelnen Leerzeile.
(Ausnahme: In einem Codeblock bleiben alle Leerzeilen erhalten.) - Leerzeilen können weggelassen werden, wenn ein Markup oder eine Einrückung die Trennung von Textkörperelementen eindeutig macht.
- Die erste Zeile im Kommentar wird so behandelt, als ob ihr eine Leerzeile vorangestellt wäre, und die letzte Zeile im Kommentar wird so behandelt, als würde ihr eine Leerzeile folgen.
Absatz- und Zeilenwechsel
- Absatzwechsel werden durch Leerzeilen gekennzeichnet (siehe Beispiele).
- Innerhalb von Absätzen wird der Text fortlaufend dargestellt und automatisch umgebrochen, wenn die Fensterbreite des Bibliotheksverwalters erreicht wird. Einfache Zeilenumbrüche im Kommentar bewirken keinen Zeilenumbruch in der Darstellung. Um Zeilenwechsel zu realisieren, werden zeilenorientierte Textblöcke (Zeilenblöcke) verwendet.
Einrückung
- Einrückungen werden verwendet, um verschachtelte Inhalte zu kennzeichnen (siehe Beispiele).
- Jede Textzeile, dessen Einrückung kleiner ist als die der aktuellen Ebene, beendet die aktuelle Ebene der Einrückung.
- Für die Einrückung können Leerzeichen oder Tabulatoren verwendet werden. Da alle Einrückungen signifikant sind, muss der Grad der Einrückung konsistent sein.
Beispiele
Textblock (Absatz)
Wenn ein Absatz oder ein anderes Konstrukt aus mehr als einer Textzeile besteht, müssen die Zeilen linksbündig ausgerichtet sein.
This is a paragraph. The lines of
this paragraph are aligned at the left.
This paragraph has problems. The
lines are not left-aligned.
|
Siehe auch: Textblock (Absatz)
Eingerückter Textblock (Blockzitat)
Die Einrückung ist die einzige Kennzeichnung für Blockzitate (eingerückter Textblock).
- Eine Leerzeile zwischen einem Textblock (Absatz oder Blockzitat) und einem nachfolgenden eingerückten Textblock (Blockzitat) ist optional. Durch die Einrückung des nachfolgenden Textblocks erfolgt am Ende der vorherigen Textblocks ein Umbruch. Wenn eine Leerzeile im Kommentar eingefügt wird, erfolgt der Umbruch und die Leerzeile bleibt in der Darstellung erhalten.
- Zwischen einem eingerückten Textblock (Blockzitat) und einem nachfolgenden nicht eingerückten Textblock (Absatz oder Blockzitat) wird automatisch, unabhängig davon, ob im Kommentar eine Leerzeile eingefügt ist oder nicht, eine Leerzeile dargestellt. Die aktuelle Ebene der Einrückung wird beendet.
- Zwischen zwei Textblöcken (Blockzitate) auf einer Einrückungsebene muss im Kommentar eine Leerzeile eingefügt werden, um die Textblöcke voneinander zu trennen.
This is a top-level paragraph.
This paragraph belongs to a first-level block quote.
This is the second paragraph of the first-level block quote.
This paragraph belongs to a second-level block quote.
Another top-level paragraph.
This paragraph belongs to a second-level block quote.
This paragraph belongs to a first-level block quote. The
second-level block quote above is inside this first-level
block quote.
|
Siehe auch: Eingerückter Textblock (Blockzitat)
Zeilenorientierter Textblock (Zeilenblock)
Mit einem Zeilenblock kann ein Zeilenwechsel realisiert werden. Durch Einrückungen können einzelne Zeilen eingerückt werden.
| Each new line begins with
| a vertical bar ("|").
| Line breaks and initial indents
| are preserved.
| Continuation lines are wrapped
portions of long lines; they begin
with spaces in place of vertical bars.
|
Siehe auch: Zeilenorientierter Textblock (Zeilenblock)
Einfache und komplexe Markup
Mehrere Konstrukte beginnen mit einem Markup. Der Körper des Konstrukts muss dann relativ zum Markup eingerückt werden.
Bei Konstrukten mit einfachen Markup (ungeordnete und geordnete Aufzählungslisten, Fußnoten, Zitate, Hyperlink-Ziele, Direktiven und Kommentare) wird der Grad der Einrückung des Körpers durch die Position der ersten Textzeile bestimmt, die auf derselben Zeile beginnt wie das Markup.
- This is the first line of a bullet list
item's paragraph. All lines must align
relative to the first line. [1]_
This indented paragraph is interpreted
as a block quote.
Because it is not sufficiently indented,
this paragraph does not belong to the list
item.
.. [1] Here's a footnote. The second line is aligned
with the beginning of the footnote label. The ".."
marker is what determines the indentation.
|
Bei Konstrukten mit komplexeren Markup bestimmt in der Regel die Einrückung der ersten Zeile nach dem Markup den linken Rand des Textkörpers. Wenn das Markup sehr lang ist, kann es sinnvoll sein, mit dem Textkörper in der nächsten Zeile zu beginnen. Die Zeile nach dem Markup muss um mindestens ein Leerzeichen eingerückt sein (minimale Einrückung).
:Field: This field has a short field name, so aligning the field
body with the first line is feasible.
:This field has a long field name: It would
be very difficult to align the field body with the left edge
of the first line.
:This field also has a long field name:
It would be very difficult to align the field body with the left edge
of the first line. It may even be preferable not to begin the
body on the same line as the marker.
|
Siehe auch: