Sandcastle (software) - Overview

Overview

Sandcastle is a set of command line programs, configuration files, build components and XSLT transformation files that work together to convert XML-based documentation into help topics that are fit for viewing in a help system. Sandcastle is typically used to automatically generate web-ready, XML-compliant HTML documentation in one of three built-in presentation styles from .NET assemblies and XML documentation files that are generated by code compilers. The resulting HTML files are then used as input to tools such as the HTML Help Workshop to produce compiled help for distribution with a software application.

Sandcastle currently features a lightweight graphical user interface (GUI) as an alternative to the MSBuild project, batch script and Windows PowerShell scripts that are also provided. Several community GUI tools are also available for Sandcastle, providing additional features and simplifying its usage.

The Visual Studio SDKs for 2005 and 2008 include older CTP versions of Sandcastle, although the latest release is available on CodePlex.

Read more about this topic:  Sandcastle (software)