Announcing December 2006 Sandcastle CTP


The December 2006 CTP version for Sandcastle is now available for download at Our sincere thanks to the Sandcastle user community and to Eric Woodruff for providing us with valuable feedback.

What’s new in this version:

  1. Sandcastle installer is now setting the DXROOT environment variable to the installation directory. All config files new has a DXROOT environment variable.

  2. MrefBuilder now Exclude (Ripping) Namespace, types and membersExclude (Ripping) Namespace, types and members are configured through MrefBuilder.config. This issue was discussed at

  3. The following HTML tags will pass through unchanged just like all the other HTML tags:

<br/>, <hr/>, <h1></h1>, <h2></h2>, <h3></h3>, <h4></h4>, <h5></h5>, <h6></h6>, <pre></pre>, <div></div>, <span></span>, <blockquote></blockquote>, <abbr></abbr>, <acronym></acronym>.

  1. Support for separate member pages (similar to VS2005). In order to have separate member pages, you have to run a new transform ApplyVsDocModel.xsl instead of AddOverloads.xsl:


XslTransform /xsl:..\..\ProductionTransforms\ApplyVSDocModel.xsl /xsl:..\..\ProductionTransforms\AddGuidFilenames.xsl /out:reflection.xml


Separate pages will be created for members, methods, properties, events, fields and constructors.

  1. VS 2005 transforms support for FireFox.

Changes in this version:

1.     Updated Sandcastle.config files for Prototype and VS2005 to include DXROOT variable.

2.     Added new transform ApplyVsDocModel.xsl to support induvidual member pages for VS2005 transforms.

Issues fixed in this version:

1.    MrefBuilder internal+ switch not working. This was a regression in November CTP.

2.    The Presentation\Prototype\Scripts\StyleUtilities.js file causes pages to throw JavaScript errors when it tries to access a style sheet with an ms-help URL when the page is loaded via an  http:// URL.

3.    There is an IE-specific reference to the event object that does not work in FireFox in the Presentation\VS2005\Scripts\script_manifold.js file.

4.    When using FriendlyFilenames explicit interface methods are not compiled in CHM file –

5.    The caption of my <seealso> tag does not appear

6.    When using the <c> tag, the text within it appears in a slightly different font

7.    When building for the VS2005 presentation style, it not longer displays the text indicating where an inherited member has been inherited from.

8.    The code in the <example> tag does not appear in a light blue color like it does when compiled for the prototype presentation style

9.    Bug: Root-chickenfeet item (namespaces) is no hyperlink anymore

10.  Sandcastle Feature request

11.  Bug in Prototype style’s utilities_reference.xsl file.  If you disable the C# language filter, it doesn’t display the syntax for the first tab until you click on it.

12.  MSDN links does not point to a language other than the English site. Fixed the ResolveReferenceLinksComponent hard codes the language (“en-US”) for the URLs.

13.  Bug in the processing of the <overloads> summary information.

14.  Unavle to build Wintellect (  dlls (

15.  Given a generic base class with an overloaded method, MRefBuilder incorrectly lists the first member found for all overloads in the type’s <elements> list.  It does correctly generate an <api> entry for each method.  However, because they aren’t in the <elements> list, the other methods do not get documented.  If the first method is internal or private, it shows up in the element list when it shouldn’t and also hides the other public overloads.  The problem does not occur if the “<T>” generic type is replaced with a non-generic type such as string.

16.  When specifying a <permission /> in doc, the set of required permissions renders in the end documentation in a table, but it doesn’t have the same styling as other tables (like the exceptions table), making it inconsistent and sort of hard to read.  Styles are missing for permissions section under prototype.

Issues not fixed in this version:

1.    CHM is missing state –

2.    Bug: Interihance Hierarchy VS2005 incorrect when using inner classes due to issue in BuildComponents.

3.    Both the Prototype and VS2005 styles aren’t showing the “obsolete” messages for items with an ObsoleteAttribute.

4.    In the member lists, do not list all overloads; just list the member name with a jump to the topic containing the overload list (as done in MS-VS2005 documentation).

5.    In vs2005 transform, there are only classes, interfaces in TOC, no their members any more.

 I would love to hear your feedback about this CTP.


Comments (10)

  1. Sandcastle Announcing December 2006 Sandcastle CTP Sandcastle 12월 CTP가 나왔습니다. DXROOT 환경변수를 사용하여 설치되는

  2. You’ve been kicked (a good thing) – Trackback from

  3. B# .NET Blog says:

    I blogged about Sandcastle in the past, over here . You can grab the December 06 CTP from the Microsoft-website

  4. CoqBlog says:

    La CTP de Décembre de Sandcastle est disponible, vous pouvez consulter la liste des changements sur le

  5. News &amp; Highlights [Announcements] Let the Games Begin! (XNA Game Studio Express) – Canadian Developers

  6. mattgollob says:

    ApplyVsDocModel.xsl is great, but there are some items missing from reference_content.xml that are necessary to support the html output.  Those items are:

    <item id="constructorsTopicTitle">{0} Constructors</item>

    <item id="membersTopicTitle">{0} Members</item>

    <item id="methodsTopicTitle">{0} Methods</item>

    <item id="propertiesTopicTitle">{0} Properties</item>

    <item id="fieldsTopicTitle">{0} Fields</item>

    <item id="eventsTopicTitle">{0} Events</item>

    <item id="Publicmethod">Public Methods</item>

    <item id="Protectedmethod">Protected Methods</item>

    <item id="Publicconstructor">Public Constructors</item>

    <item id="Protectedconstructor">Protected Constructors</item>

    <item id="Publicproperty">Public Properties</item>

    <item id="Protectedproperty">Protected Properties</item>

    <item id="Publicfield">Public Fields</item>

    <item id="Protectedfield">Protected Fields</item>

    <item id="Publicevent">Public Events</item>

    <item id="derivedClasses">Derived Types</item>

    <item id="DerivedTypeListTopicTitle">{0} Derived Types</item>

    There could be more, but these are all the ones I found in my testing.

  7. Smöråkning says:

    Installation instructions: If you haven’t already done so, install the Sandcastle December CTP . The

  8. andlju says:

    I’ve updated the MSBuild script for Sandcastle to better support the December CTP. You’ll find the release at the CodePlex site:

    I prefer to handle any questions on my blog:

  9. erykpax says:

    Good job guys with this december release, we were able to generate great documentation.

    A little question: Sandcastle components output a lot of text to the console (particularly BuildAssembler). Is it possible to disable (or at least decrease) these messages ?


    Info: BuildAssembler: Building topic T:BSI.ECSystem.Authentication.IAuthenticationServer

    Info: BuildAssembler: Building topic M:BSI.ECSystem.Authentication.IAuthenticationServer.Authenticate(Bentley.ECSystem.Sess




  10. Zolpidem overnight. Zolpidem overdose. Zolpidem.