Notes
We use four note types: Note, Tip, Caution, Warning.
Follow these guidelines when creating notes:
- Do not add bold text as titles to note elements.
- Avoid adding multiple notes to a single topic. The purpose of notes is to call attention to something very important on the page.
- A note may be added to a procedure, when necessary.Remember to apply the note's attribute. However, if you forget, the current portal CSS renders this container as a general note.
Note: This is a note with no attribute applied.
- Create a note element.
- Select the Attributes tab, then scroll the attributes list to locate the Type attribute.
- Select from one of the following options:
Purpose Style Use the note attribute to call attention to helpful, but non-urgent information. Note: This is a note element with a note attribute applied.Use tip to impart expert knowledge or advice. It's like a gift to the reader. Tip: This is a note element with a tip attribute applied.Use caution sparingly. Cautions are used to indicate possible loss of data or functionality. CAUTION: This is a note element with a caution attribute applied.A warning is used to indicate extreme destruction of data, hardware systems, or personal harm. In our business, these are rarely used. Warning: This is a note element with a warning attribute applied.There is no CSS applied to other note attributes that are not documented on this page. If you select one of these styles, the CSS will not format the note. If you have an ongoing need for other note types, please contact the Content Lead who will coordinate with design and CSS programming.