How does the Note tag and the types work in SandCastle?

Feb 17, 2008 at 6:58 PM
Hi,

I wonder what I'm doing wrong with the note tags.

In the project the following comments are added on a method:
/// <note type="inheritinfo">Test the note tag - inheritinfo</note>
/// <note type="caution">Test the note tag - caution</note>
/// <note type="implementnotes">Test the note tag - implementnotes</note>

The result from this are:
Note:Test the note tag - inheritinfo
Note:Test the note tag - caution
Note:Test the note tag - implementnotes

I thought the result would be in a table. Where the type of the Note-tag was the header and the Text was the content of the table. (example):
Note to inheritors:
Test the note tag - inheritinfo


I've found the types of the Note-tag on the following site:
http://www.dynicity.com/products/xmldoccomments.aspx

Are these types supported by SandCastle and how do I implemnet them?

Best regards,
Tony
Feb 17, 2008 at 8:17 PM
Hi Tony,

The XSL template that processes <note> elements is defined in the main_sandcastle.xsl file, found in each presentation style's transforms folder. Open the file in Visual Studio's XML editor and search for <xsl:template match="note">. They're all basically the same:

<xsl:template match="note">
  <div class="alert">
    <img>
      <includeAttribute item="iconPath" name="src">
        <parameter>alert_note.gif</parameter>
      </includeAttribute>
      <includeAttribute name="title" item="noteAltText"/>
    </img>
    <xsl:text> </xsl:text>
    <include item="noteTitle" />
    <xsl:apply-templates />
  </div>
</xsl:template>
The type attribute doesn't appear to be used at all.

- Dave
Feb 17, 2008 at 11:13 PM

Are these types supported by SandCastle and how do I implemnet them?


Not yet supported. I have raised this issue a while back and was discussed here
http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=2405370&SiteID=1

The "alert" tag is extensively supported under the conceptual help. If you wish to
modify the transform files yourself then take a look at the conceptual transforms
for ideas.

Best regards,
Paul.
Feb 18, 2008 at 5:59 AM
Hi again,

I gave it a thought and changed the note-template so it works like I describe earlier. Like the part of SandCastle, when you can modify the standard apperance.

Thanks for the answers.

- Tony