.. include:: ../Includes.txt .. highlight:: rst .. _rest-admonitions: ======================================= 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 -------- .. code-block:: rest .. seealso:: `Admonitions `__ .. seealso:: `Admonitions `__ Note ---- .. code-block:: rest .. note:: A note .. note:: A note Tip --- .. code-block:: rest .. 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 --------- .. code-block:: rest .. important:: Some important information which should be considered. .. important:: Some important information which should be considered. Warning ------- .. code-block:: rest .. 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 --------- .. code-block:: rest .. 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 `__.