Note types
This style guide recognizes four types of supplementary content: Note, Tip, Important, and Caution.
>Note - A block with the heading "Note" indicates neutral or positive information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases. Examples are memory limitations, equipment configurations, or details that apply to specific versions of a program.
>Tip - A tip is a type of note that helps users apply the techniques and procedures described in the text to their specific needs. A tip suggests alternative methods that may not be obvious and helps users understand the benefits and capabilities of the product. A tip is not essential to the basic understanding of the text.
>Important - An Important block provides information that is essential to the completion of a task. Users can disregard information in a note and still complete a task, but they are not advised to disregard an important block.
>Caution - A caution block advises users that failure to take or avoid a specific action could result in loss of data, unexpected results, errors, or irreversible changes. The term "Caution" is preferred over "Warning" because of ANSI 353.
Below you can find a simple use case as well as the appearance in the actual documentation:
Declaration in Markdown:
Actual Appearance:
The notes are created through the alert_generator.rb and alert_processor.rb plugins in the /_plugins folder of the documentation. Their style can be altered through the styles.css file in the /_assets/stylesheets folder.