Inline-Markup

Inline-Markup werden in reStructuredText zur Auszeichnung von Wörtern oder Phrasen innerhalb eines Textblocks verwendet. Wörter und Phrasen können so formatiert oder mit einer Funktion versehen werden.

Inline-Markup bestehen aus einem Start- und Endzeichen, die das auszeichnende Wort oder die Phrase umschließen.

Verwendung

Inline-Markup werden für folgende Konstrukte verwendet:

Konstrukte mit identischem Start- und Endzeichen:

Verwendung	Beispiel
Hervorgehobener Text (kursiv)	emphasized text
Stark hervorgehobener Text (fett)	strong text
Inline-Literale (Konstantschrift)	``inline literals``
Substitutionsreferenzen	\|substitution reference\|

Konstrukte mit unterschiedlichem Start- und Endzeichen:

Verwendung	Beispiel
Hyperlink-Referenz (inline, intern, extern, indirekt) (Hyperlinks)	Wort: Target_ Phrase: `Hyperlink target`_
Anonyme Hyperlink-Referenz	Wort: Target__ Phrase: `Hyperlink target`__
Eingebettete URIs und Aliases	Eingebetteter URI: `Beckhoff home page <http://www.beckhoff.de>`_ Alias: `link <Beckhoff home page_>`_
Alleinstehende Hyperlinks	http://www.beckhoff.de support@beckhoff.com
Fußnotenreferenz (Fußnoten)	Manuelle Nummerierung: [1]_ Automatische Nummerierung: [#]_ Automatische Symbolgenerierung: [*]_
Zitatreferenz	[CIT]_
Inline-Hyperlinks	Wort: _Inline-hyperlink-target Phrase: _`Inline target`

Regeln für die Erkennung von Inline-Markup

Inline-Markup können nicht verschachtelt werden. Start- und Endzeichen von Inline-Markup werden nur erkannt, wenn die folgenden Bedingungen erfüllt sind:

Dem Startzeichen darf kein Leerzeichen folgen
Dem Endzeichen darf kein Leerzeichen vorangestellt werden.
Das Startzeichen muss einen Textblock beginnen oder ihm muss unmittelbar ein Leerzeichen oder eines der Zeichen - : / ' " < ( [ { vorangestellt werden.
Das Endzeichen muss einen Textblock beenden oder ihm muss unmittelbar ein Leerzeichen oder eines der Zeichen ' " . , : ; ! ? - ) ] } / \ > folgen.
Das Endzeichen muss durch mindestens ein Zeichen vom Startzeichen getrennt sein.
Sowohl dem Start- als auch dem Endzeichen darf kein Backslash vorangestellt werden (außer dem Endzeichen von Inline-Literalen). Ein Backslash, der einem Start- oder Endzeichen vorausgeht, deaktiviert die Markup-Erkennung, mit Ausnahme des Endzeichens von Inline-Literalen.
Wenn einem Startzeichen unmittelbar eines der Zeichen ' " ( [ { < vorangestellt wird, darf ihm nicht unmittelbar das entsprechende Zeichen ' " ) ] } > folgen (nicht möglich: "*"text"*", möglich: (*(text)*)).

Inline-Markup auf Zeichenebene

Es ist möglich, einzelne Zeichen innerhalb eines Wortes mit einem Backslash zu markieren, damit beliebiger Text sofort nach dem Inline-Markup folgen kann.

Python ``list``\s use square bracket syntax.

Inline-Markup 1:

Der Backslash verschwindet aus dem bearbeiteten Dokument. Das Wort „list“ erscheint in Konstantschrift, und der Buchstabe „s“ folgt sofort als normaler Text, ohne Zwischenraum.

Beliebiger Text kann dem Inline-Markup durch die Verwendung von Backslash und Leerzeichen vorangestellt werden.

Possible in *re*\ ``Structured``\ *Text*, though not encouraged

Inline-Markup 2:

Die Backslashes und Leerzeichen zwischen „re“, „Structured“ und „Text“ verschwinden aus dem bearbeiteten Kommentar.

	Die Verwendung von Backslash für Inline-Markierungen auf Zeichenebene wird nicht empfohlen. Eine solche Verwendung erschwert die Lesbarkeit des unverarbeiteten Kommentars. Nutzen Sie diese Funktion sparsam und nur dort, wo es unbedingt notwendig ist.

Siehe auch: Escaping-Mechanismus