Windows Live Alerts Sandcastle - Site Home - MSDN Blogs

Sandcastle

Documentation compilers for managed class libraries

Blog - About

About Sandcastle

<?xml:namespace prefix = st1 ns = "urn:schemas-microsoft-com:office:smarttags" /><st1:place w:st="on">Mission</st1:place> Statement:<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" /><o:p></o:p>

Enabling managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel<o:p></o:p>

Overview<o:p></o:p>

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features:<o:p></o:p>

  • Works with or without authored comments <o:p></o:p>
  • Supports Generics and .NET Framework 2.0 <o:p></o:p>
  • Sandcastle has 2 main components (MrefBuilder and Build Assembler) <o:p></o:p>
  • MrefBuilder generates reflection xml file for Build Assembler <o:p></o:p>
  • Build Assembler includes syntax generation, transformation..etc <o:p></o:p>
  • Sandcastle is used internally to build .Net Framework documentation <o:p></o:p>

<o:p> </o:p>

System Requirements<o:p></o:p>

Supported Operating Systems: <o:p></o:p>

Windows Server 2003; Windows XP Service Pack 2<o:p></o:p>

Required Software: <o:p></o:p>

Microsoft .NET Framework Version 2.0, available here <o:p></o:p>

HTML Help Workshop<o:p></o:p>

Optional Software: <o:p></o:p>

Visual Studio 2005 or Visual Studio SDK<o:p></o:p>

 

Support<o:p></o:p>

Please post all Sandcastle related questions and discussions at http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=66&SiteID=1. <o:p></o:p>

 <o:p></o:p>

You can also send feedback and bugs to sandchlp@microsoft.com.

 

 

  • Sandcastle

    Creating a Chm build using Sandcastle

    • 65 Comments
    Here are the steps to create a Chm build using Sandcastle. Please see the atatchment for the steps in text format. Prerequisites: 1. .Net Framework 2.0 2. For Chm generation download HTML Help Workshop - http://msdn.microsoft.com/library/default...
  • Sandcastle

    A few faqs about Sandcastle

    • 42 Comments
    I’m super excited about the response to the Sandcastle CTP launch. Much of the response has been positive, and folks have asked some great questions. Let me try to address a few of the common questions people have about the site: Where can post Sandcastle...
  • Sandcastle

    Sandcastle June 2010 Release

    • 12 Comments
    I am happy to announce that we have posted an updated version of Sandcastle to Codeplex . I know this was a very long wait for everyone. This release brings Sandcastle to parity with the code that was used to generate the Visual Studio 2010 and .NET...
  • Sandcastle

    Announcing Sandcastle CTP

    • 35 Comments
    Sandcastle CTP can now be downloaded at http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en Instructions: 1. Visit the above link to download and install Sandcastle. 2. After installing...
  • Sandcastle

    Sandcastle Version Supporting VS 2010, .NET 4 and Microsoft Help Viewer

    • 7 Comments
    We released the source code for Sandcastle a year ago ( http://sandcastle.codeplex.com/SourceControl/ListDownloadableCommits.aspx ) supporting Visual Studio 2010 Beta 1 documentation. After this release we were extremely busy in releasing the new Help...
  • Sandcastle

    Sandcastle project removed from Codeplex

    • 16 Comments
    We have removed Sandcastle project from Codeplex after carefully evaluating the feedback from this thread http://www.codeplex.com/Sandcastle/Thread/View.aspx?ThreadId=29085 (currently unavailable) . There are few options such as the following: ...
  • Sandcastle

    Sandcastle Release

    • 9 Comments
    Per my previous blog post http://blogs.msdn.com/sandcastle/archive/2009/01/15/sandcastle-update.aspx , I have released the source code for the latest version of Sandcastle at http://sandcastle.codeplex.com/SourceControl/ListDownloadableCommits.aspx ....
  • Sandcastle

    Supporting Custom tags in Sandcastle

    • 10 Comments
    Sandcastle supports C# (and VB) xml tags for developer documentation comments. The list of c# tags are available at http://msdn2.microsoft.com/en-us/library/5ast78ax.aspx . We added the following new custom nDoc tags in November CTP ( http://www.microsoft...
  • Sandcastle

    Sandcastle Overview

    • 13 Comments
    Attached power point slides provide a high level overview of Sandcastle. I will be posting more design details after we ship the CTP version Anand..
  • Sandcastle

    Sandcastle Update

    • 4 Comments
    Thank you for using Sandcastle and providing with valuable feedback. It is always good to get emails from this community about Sandcastle. Today Microsoft MVP Michael Cummings , principal consultant @ http://www.magenic.com/ , contacted me about a thread...
  • Sandcastle

    MRefBuilder (EXE)

    • 12 Comments
    I my previous blog I discussed Sandcastle.config in detail. Sandcastle process uses three executables: MRefBuilder: Reflects over managed assemblies to produce an XML-formatted reflection information file. BuildAssembler: Collates information...
  • Sandcastle

    Building CHM using CHMBuilder

    • 5 Comments
    Please see my blog about Sandcastle September 2007 release . With this release, we plan on shipping a new tool called CHMBuilder for CHM generation using Sandcastle. What is CHMBuilder? CHMBuilder is an executable that will be shipped under the...
  • Sandcastle

    Integrating Sandcastle doc generation to your NAnt builds

    • 2 Comments
    NAnt is an open source software tool for automating software build processes. It is based on Apache Ant and targeted at the .NET environment whereas Ant is a more generic cross-platform tool principally used by Java programmers . Brett Burch from...
  • Sandcastle

    Announcing Sandcastle Version 2.4.10115

    • 7 Comments
    I am excited to announce the availability of Sandcastle Version 2.4.10115. The latest version is now available for download at http://www.codeplex.com/Sandcastle . My sincere thanks to the Sandcastle user community for providing us with valuable feedback...
  • Sandcastle

    Announcing December 2006 Sandcastle CTP

    • 10 Comments
    The December 2006 CTP version for Sandcastle is now available for download at http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en . Our sincere thanks to the Sandcastle user community and to...
  • Sandcastle

    Genereating Website for API documentation using Sandcastle

    • 1 Comments
    In this blog on generating builds using Powershell , I provided details on generating a single command wrapper to build CHM and HxS files regardless of where the source assemblies and comments are located. This powershell script provided the following...
  • Sandcastle

    Resolving reference links in Sandcastle using none, local, index and msdn link type options

    • 9 Comments
    Sandcastle supports 4 different link type options. The link type options are defined in sandcastle.config file under ResolveReferenceLinks component. The 4 different type options under this component are the following: none - Results in text with...
  • Sandcastle

    Announcing Sandcastle

    • 13 Comments
    We will be releasing the CTP version of Sandcastle shortly. There are couple places (download at our download center and also as a part of VS SDK) we are targeting to release our CTP version. Also as soon as the CTP is posted I will provide the information...
  • Sandcastle

    CHM Localization and Unicode issues - dbcsFix.exe

    • 6 Comments
    In this thread ( http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=2139818&SiteID=1 ) we discussed about the localization issues in CHM. With September Sandcastle release we have addressed the Unicode issues for CHMs built in East Asian languages...
  • Sandcastle

    Announcing March 2007 Sandcastle CTP

    • 15 Comments
    I am excited to announce the availability of March 2007 CTP version for Sandcastle. The latest version is now available for download at http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&displaylang=en ....
  • Sandcastle

    What's new in August 2006 Sandcastle CTP

    • 16 Comments
    August 2006 Sandcastle CTP is currently available at http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en . Here is a summary of what's new in this CTP version: Firefox support for Sandcasltle...
  • Sandcastle

    Filtering APIs using Sandcastle

    • 4 Comments
    API filters in Sandcastle is a very useful feature and allows namespaces, types, and members to be removed or shown in the reflection XML file, and ultimately in the compiled docs. They can be set up so that only certain topics are dropped, or so that...
  • Sandcastle

    Sandcastle Source Code published in Codeplex

    • 11 Comments
    I am very pleased to announce the availability of the Sandcastle project with source code at http://www.codeplex.com/Sandcastle . The source code can be downloaded from the Releases tab at http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx...
  • Sandcastle

    Joe in Iowa – A Sandcastle Scenario

    • 11 Comments
    This post provides steps to create CHM using Sandcastle. Some of the users have automated these steps. Mikael Söderström has a "Sandcastle Helper" here , Ashley van Gerven has a batch script available here and Scott Hanselman's has power shell script...
  • Sandcastle

    Sandcastle Configuration (sandcastle.config)

    • 16 Comments
    Overview Sandcastle builds documentation for any managed class libraries. Sandcastle requires the following inputs: A set of managed assemblies (.dlls or .exes) to document The set of assemblies on which the operation of those assemblies depend...
Page 1 of 5 (109 items) 12345