Direktiven

Direktiven gehören zu den expliziten Markup-Blöcken. Es handelt sich dabei um Syntaxelemente, die Auswirkungen auf einen ganzen Absatz haben.

Aufbau

Direktiven bestehen aus einer Direktivenmarkierung gefolgt von einem Direktivenblock.
Die Direktivenmarkierung setzt sich aus einem expliziten Markup-Start („.. “), dem Typ der Direktive, zwei Doppelpunkten und einem Leerzeichen zusammen.
Der Direktivenblock besteht aus drei Teilen, wobei einzelne Direktiven beliebige Kombinationen dieser Teile verwenden:

Direktivenargument
Direktivenoptionen
Direktiveninhalt

Direktivenargumente können Dateisystempfade, Titeltexte usw. sein.
Die Angabe der Direktivenoptionen erfolgt über Feldlisten, wobei die möglichen Feldnamen und Inhalte vom Typ der Direktive abhängen.
Direktivenargumente und -optionen müssen einen zusammenhängenden Block bilden, der mit der ersten oder zweiten Zeile des expliziten Markup-Blocks beginnt.
Der Anfang des Inhaltsblocks der Direktive wird durch eine Leerzeile kennzeichnet.

Prinzip

+-----+-----------------------------+ |".. "|directive type"::" directive | +-----+block | | | +-----------------------------+

Zwischen einer Direktive und einem vorangehenden Textkörperelement (z. B. einem Absatz mit Text) ist eine Leerzeile notwendig. Eine Leerzeile zwischen Direktiven ist optional.

Beispiel:

Paragraph

.. image:: C:\Tc3LibDocImages\SampleLib1\img11.jpg
.. image:: C:\Tc3LibDocImages\SampleLib1\img12.jpg

Verwendung

Über Direktiven können folgende Textköperelemente erzeugt werden:

Verwendung	Beispiel
Spezifische Hinweise	.. note::
Generische Hinweise	.. admonition:: Title
Bilder	.. image:: C:\Users\SampleUser\Documents\LibraryDocumentationpicture.png :height: 100 px :width: 200 px
Codeblock	.. code:: Code block
CSV-Tabelle	.. csv-table:: Table :header: "Column 1", "Column 2" :widths: 50, 50 "Line 1.1","Line 1.2"
Listentabelle	.. list-table:: Table :widths: 50 50 :header-rows: 1 * - Column 1 - Column 2 * - Line 1.1 - Line 1.2