Note
The class attribute value is case-sensitive. Unrecognized values will default to the "note" alert style.
Sandcastle MAML Guide
alert
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.
The class attribute can be any of the following values which fall into five 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 |
To Do | todo |
An optional title attribute can be used to provide a user-defined title that it will override the default title.
Example
<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>
<alert class="todo">
<para>This could contain a To Do list.</para>
</alert>
<alert class="todo" title="Project Road Map">
<para>This alert contains a custom title.</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.
To Do
This could contain a To Do list.
Project Road Map
This alert contains a custom title.