Tip, Note, Important etc. (Admonitions)

The following directives are called Admonitions. You can use them to point out additional or important information.

Examples

See Also

.. seealso::
   `Admonitions <http://docutils.sourceforge.net/0.7/docs/ref/rst/directives.html#admonitions>`__

See also

Admonitions

Note

.. note::
   A note

Note

A note

Tip

.. tip::
   A tip

Tip

A tip

You may also use the admonition hint, but this is very similar and tip is more commonly used in the documentation.

Important

.. important::
   Some important information which should be considered.

Important

Some important information which should be considered.

Warning

.. warning::
   Some text pointing out something that people should be warned about.

Warning

Some text pointing out something that people should be warned about.

You may also use the admonitions caution or even danger if the severity of the warning must be stressed.

Attention

.. attention::
   A attention

Attention

A attention

More Information

The admonitions listed here are the most commonly used in the TYPO3 documentation.

For more see reStructuredText directives in docutils documentation.