What’s new in September 2006 Sandcastle CTP

September 2006 Sandcastle CTP is now available at Microsoft download center. Here is a summary of what’s new in this CTP version:

  1. Visual Studio 2005 look and feel transforms.
  2. State of Syntax tab persists across topics in HxS build.
  3. Transforms for hiding explicit interface implementations.
  4. Index and keyword generation in HxS build. To generate Index and keyword for HxS build please modify sandcastle.config. Under the transformation step in sandcastle.config, change
                <argument name=”metadata” value=”false” />
                <argument name=”metadata” value=”true” />

Note: We are providing VS 2005 transforms under Presentation/VS2005 folder and the transforms shipped with the previous versions under Presentation/Prototype folder. For building VS2005 format please use sandcastle.config file from C:\Program Files\Sandcastle\Presentation\vs2005\Configuration folder as it uses shared content from C:\Program Files\Sandcastle\Presentation\vs2005\Content and transforms from C:\Program Files\Sandcastle\Presentation\vs2005\Transforms

Known issues:

  1. State of syntax tab do not persist across topics in CHM build. We will provide a hot fix for CHM after the release of September CTP.

  2. In C:\Program Files\Sandcastle\Presentation\vs2005 folder please modify the following:

    1. Edit CopyHavana.bat and change the path Prototype to vs2005.
    2. Edit test.hhp under C:\Program Files\Sandcastle\Presentation\vs2005\Chm folder and change the value icons to art.
    3. Edit test.hxf under C:\Program Files\Sandcastle\Presentation\vs2005\Hxs folder and changes icons to art.

  3. See Also section not generated for builds with VS 2005 look and feel. Please remove the xml comments for the following section in main_sandcastle.xsl for VS 2005 transforms under C:\Program Files\Sandcastle\Presentation\vs2005\Transforms:

<!– see also –>
    <!–<xsl:call-template name=”seeAlsoSection” />–>

Bug Fixes:

The following bugs have been fixed for this CTP:

  1. Sandcastle transforms does not process all XML elements from code comments
  2. MrefBuilder: Display friendly log message when “comments” are missing in config file
  3. Bugs in documenting lists
  4. F-keywords are not generated by the HxS
  5. Exception tag from XML comments are not being populated in .chm file
  6. Lists are not documented properly
  7. Buildassembler generates indexoutofrangeexception
  8. Visaul bug for R:Project
  9. August CTP and Inherited Interface Implementations
  10. Overloads do not display properly in Contents-tab
  11. August CTP: Problem with attributed fields
  12. Mrefbuilder crash on several VS dlls
  13. Syntax tab selection does not persist across topics
  14. Issues with localized XML files
  15. HHC file name not supported with extended characters
  16. C++ set methods for properties are still documented with an extra comma.
  17. The <seealso> tag seems to work just like the <see> tag.
  18. The parameters just look like an empty constructor in the HTML
  19. August CTP : <c> tag not working
  20. Attributes on methods
  21. Aug CTP: <seealso> tag not working
  22. Generic types are not displayed in method declaration
  23. Return-only generic type parameter not listed in doc
  24. Where clause not part of the doc




Comments (12)

  1. Sandcastle : What’s new in September 2006 Sandcastle CTP 8월부터 CTP를 공개했던 SandCastle이 9월에도 CTP가 나왔습니다….

  2. September2006 Sandcastle CTP will be available by tomorrow (October 1, 2006)at Microsft download center.

  3. Garry Trinder says:


    It appears the "msi" is still not updated. It say’s the date piblished is August 27, 2006. This will be updated to today’s date as soon as the new bits are available.

    I will let you know as soon as it’s updated.


  4. gfraiteur says:


    How to generate the list of all members with the VS2005 presentation? Is it missing in this release or I am forgetting a build step?

    Thank you.


  5. neilthespod says:

    I notice that the seeAlso commented out line references a template that does not exist under the VS2005 directory. So I coped the template from the Prototype directory and it seemed to pass then – though I don’t make much use of seeAlso, so I can’t be aboslutely sure it works.

    In addition, despite making the changes as shown above, the icons for Collapse and Expand are failing to render – I haven’t looked into it too much so far


  6. whoisvaibhav says:

    I had the same problem as Neil. I am going to try the same thing as he did.

    I also noticed that there is another section down the line in the file which is commented out (under the inline tags)

    <!–<xsl:template match="seealso"> …. .. –>

    Is it alright to uncomment this?

    – V

  7. whoisvaibhav says:

    Another question from me:

    When I end up creating the chm file using the steps provided in this blog, it works very nicely (after a few hacks here and there). The only problem is that in the chm file I get two copies of ALL topics. Basically, the root node is duplicated (I get two root nodes).

    Any suggestions?

  8. gfraiteur says:

    I had the problem when I used the AddRoot.xsl style sheet. It disappeared when i removed this transform.

  9. Garry Trinder says:

    We are providing a refresh to our September CTP which will resolve the See also and other VS2005 transforms issue.

    Also AddRoot.xsl  transform step is not necessary and I will update the blog post accordingly.


  10. trevorwr says:

    If you want the icons for Collapse and Expand to render edit C:Program FilesSandcastleProductionTransformsReflectionToChmProject.xsl and change




  11. Sandcastle says:

    NAnt is an open source software tool for automating software build processes. It is based on Apache Ant