Specific notes

Specific notes (e.g. security and warning notices) can be generated with the directives attention, caution, danger, error, hint, important, note, tip and warning. The title of the note block is specified by the directive and corresponds to the type of note.

Description

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

(See also: Directives)

Principle

.. note::

Properties

  • Specific notes can be used in the comment as ordinary body elements and contain any body elements.
  • The following note types have been implemented:
    • Attention
    • Caution
    • Danger
    • Error
    • Hint
    • Important
    • Note
    • Tip
    • Warning
  • Any text immediately following the directive mark on the same line and/or indented on the following lines is interpreted as an 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_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.
*)

Specific notes 1: