Admonition
Label
Issue 1.1 April 2006
Table 2: Admonition types
NOTE:
informative content that may
◦
defy common or cursory logic.
◦
describe a peculiarity of the Canopy implementation.
◦
add a conditional caveat.
◦
provide a reference.
◦
explain the reason for a preceding statement or provide background
for what immediately follows.
RECOMMENDATION:
suggestion for an easier, quicker, or safer action or practice.
IMPORTANT:
informative content that may
◦
identify an indication that you should watch for.
◦
advise that your action can disturb something that you may not want
disturbed.
◦
reiterate something that you presumably know but should always
keep in mind.
CAUTION!
a notice that the risk of harm to equipment or service exists.
WARNING!
a notice that the risk of harm to person exists.
General Message
Page 15