This project has moved. For the latest updates, please go here.

Change <note> icon

Topics: Developer Forum
May 22, 2009 at 4:59 PM

Is there a way to display a different icon for the <note> tag and display as an example a warning or error icon? If not, what is the best way to show these icons with any of the tags?

May 22, 2009 at 7:07 PM

Use the "type" attribute and specify the type of note you want:

General: note, tip, caution, warning, security, security note, important

Language: vb, cs, cpp, JSharp

Note to Implementers: implement

Note to Caller: caller

Note to Inheritors: inherit

The caution, warning, security, and important values get a different icon.  Everything else gets a note icon.


Sep 8, 2009 at 6:35 AM

1. I tried your suggestion, but still got the same icons.

        /// <summary> 
        ///    Increment method increments the stored number by one. 
        /// </summary>
        /// <remarks>
        /// <para>See details at <a href=""
        /// target="_blank">Change Note Icon</a></para>
        /// <note type="note">note</note>
        /// <note type="caution">caution</note>
        /// <note type="warning">warning</note>
        /// <note type="security">security</note>
        /// <note type="security note">security note</note>
        /// <note type="important">important</note>
        /// <note type="vb">vb</note>
        /// <note type="cs">cs</note>
        /// <note type="cpp">cpp</note>
        /// <note type="JSharp">JSharp</note>
        /// <note type="implement">implement</note>
        /// <note type="caller">caller</note>
        /// <note type="inherit">inherit</note>
        /// </remarks>
        public void Increment() 
        { number++; }
2. And the format is not what I want, because the note will immediately follow the icon and "Note:". 
What I need is something like in your documentation (, which means that the note will display on the second line, not in the same line as the icon or "Note:".
I searched in your documentation, but I could not find the <note> tag information. I also checked the "XML Documentation Comments Guide", from which I only saw:
<note type="caution" | "inheritinfo" | "implementnotes">description</note> 
Are there any switches (options) I have to turn on/off in the project?
Sep 8, 2009 at 3:21 PM

The example you refer to is from a conceptual topic (MAML) using the alert element which, by default, differs from the note element in the API content.  However, if you apply the Sandcastle Styles patch you will get the same behavior for both elements as we updated the API content note element to match the conceptual content alert element.



Sep 9, 2009 at 1:45 AM

Thanks. EWoodruff. It works very well :-)