Generic notes

Generic notes can be created with the admonition directive. For generic notes, you can choose the title and therefore the note type.

Description

The directive markup consists of an explicit markup start (".. ") followed by the type of directive (admonition) and two colons.

(See also: Directives)

Principle

.. admonition::

Properties

  • The directive argument corresponds to the reference title
  • A blank line must be inserted between the directive selection and the instruction block (directive content).
  • A blank line is required between the directive and a preceding text body element (for example, a paragraph with text).

Sample

(In sample project: B_DocuElements\Note elements\FB_Libdoc_GenericNotes)

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

   You can make up your own admonition too.
*)

Generic notes 1: