Admonitions: Tip, Note, Warning, See also, etc¶
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
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.
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.
More Information¶
The admonitions listed here are the most commonly used in the TYPO3 documentation.
For more see reStructuredText directives in docutils documentation.