1.5 Document Conventions

[FIXME: Admonitions are as follows.] [FIXME: application, command, term introduced for the first time, filename]

NOTE

This is a note. It describes a useful reference to the other parts of the manual or a noteworthy comment on the matter at hand. It is something worth taking note of, but you can also ignore it if you just want to follow the text flow. Most of the time notes are unrelated to the text flow, but give a little more context to it.

TIP

This is a tip. It describes a useful trick or a tidbit of information that can make your life easier. Tips are also used to describe shortcuts that more advanced users may want to take, but beginning users will probably want to ignore. You can always ignore the tips, they never contain crucial information.

IMPORTANT

This is important. It describes an issue that is important enough to be extracted out of the text flow and to be called to your attention. So pay attention to it. There is no danger of causing permanent damage if you do not ignore the admonition, but you may risk misunderstanding the matter or getting an incorrect view of it.

CAUTION

This is a caution. It describes an issue you should pay attention to and be careful about. Ignoring it may mean that you will end up wasting lots of time or other resources, or you may even cause permanent damage. You always take a risk if you decide to act against the caution, and you should understand the potential consequences beforehand.

WARNING

This is a warning. It is given on topics that are dangerous and on issues you should avoid. If something is warned against, be careful about acting in that way. You may choose to ignore a warning, but you should always understand why you are doing so and the risks you are taking.