|
|
|
This element can be used to create a note-like section within a conceptual topic to draw attention to some important information.
Usage
Enter the element in the topic and specify the type of alert using the class attribute. The content of the alert element is usually one or more paragraphs of text describing the important information.
 Note |
|---|
|
The class attribute value is case-sensitive. Unrecognized values will default to the "note" alert style. |
The class attribute can be any of the following values which fall into four different categories that use different icons to the left of the alert title. The title will generally be the alert class name or an expanded form of it.
|
Category |
Class Value |
|---|---|
|
General note |
note, tip, implement, caller, inherit |
|
Cautionary |
caution, warning, important |
|
Security |
security, security note |
|
Language note |
cs, CSharp, c#, C#, visual c# note, cpp, CPP, c++, C++, visual c++ note, vb, VB, VisualBasic, visual basic note, JSharp, j#, J#, visual j# note |
Example
|
Copy
|
|
|---|---|
<alert class="note"> <para>This is a note</para> </alert> <alert class="caution"> <para>The class attribute value is case-sensitive.</para> </alert> <alert class="security"> <para>Do not tape your password to the underside of your keyboard.</para> </alert> <alert class="cs"> <para>This could contain C#-specific usage notes.</para> </alert> |
|
Example Output
| Note |
|---|
|
This is a note |
 Caution |
|---|
|
The class attribute value is case-sensitive. |
 Security Note |
|---|
|
Do not tape your password to the underside of your keyboard. |
| C# Note |
|---|
|
This could contain C#-specific usage notes. |
