Spezifische Hinweise

Spezifische Hinweise (u. a. Sicherheits- und Warnhinweise) können mit den Direktiven attention, caution, danger, error, hint, important, note, tip und warning erzeugt werden. Der Titel des Hinweisblocks wird durch die Direktive angegeben und entspricht dem Typ des Hinweises.

Beschreibung

Die Direktivenmarkierung besteht aus einem expliziten Markup-Start („.. “) gefolgt vom Typ der Direktive (z. B. note) und zwei Doppelpunkten.

(Siehe auch: Direktiven)

Prinzip

.. note::

Eigenschaften

  • Spezifische Hinweise können im Kommentar wie gewöhnliche Körperelemente eingesetzt werden und beliebige Körperelemente enthalten.
  • Folgende Hinweistypen sind umgesetzt:
    • Achtung (Attention)
    • Vorsicht (Caution)
    • Gefahr (Danger)
    • Fehler (Error)
    • Hinweis (Hint)
    • Wichtig (Important)
    • Notiz (Note)
    • Tipp (Tip)
    • Warnung (Warning)
  • Jeder Text, der unmittelbar auf die Direktivenmarkierung auf der gleichen Zeile und/oder eingerückt auf der folgenden Zeilen folgt, wird als Anweisungsblock (Direktiveninhalt) interpretiert.
  • Zwischen der Direktive und einem vorangehenden Textkörperelement (z. B. einem Absatz mit Text) ist eine Leerzeile notwendig.

Beispiel

(Im Beispielprojekt: B_DocuElements\Note elements\FB_Libdoc_SpecificNotes)

(*
.. note:: This is a note admonition.
   This is the second line of the first paragraph.

   - The note contains all indented body elements
     following.
   - It includes this bullet list.
*)

Spezifische Hinweise 1: