Generische Hinweise

Generische Hinweise können mit der Direktive admonition erzeugt werden. Bei generischen Hinweisen ist der Titel und somit der Hinweistyp frei wählbar.

Beschreibung

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

(Siehe auch: Direktiven)

Prinzip

.. admonition::

Eigenschaften

  • Das Direktivenargument entspricht dem Hinweistitel
  • Zwischen der Direktivenmarkierung und dem Anweisungsblock (Direktiveninhalt) muss eine Leerzeile eingefügt werden.
  • 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_GenericNotes)

(*
.. admonition:: And, by the way...

   You can make up your own admonition too.
*)

Generische Hinweise 1: