This topic describes how to install Sandcastle.

To install Sandcastle

  1. Ensure that you have HTML Help Workshop installed on your machine. Creating Help 2.0 (HxS) files requires that you also have the Help 2.0 Compiler. The Visual Studio 2008 SDK meets both of these requirements.
  2. Uninstall any earlier versions of Sandcastle not installed as part of the Visual Studio 2008 SDK.
  3. Run the Sandcastle Installer, which is available on the CodePlex Web site.

If you plan to install the Visual Studio 2008 SDK, install it before you install Sandcastle. You must do this because Visual Studio 2008 SDK Setup updates the PATH and DXROOT environment variables in the registry. If those variables are updated after Sandcastle is installed, then it may not work. If you have already installed Sandcastle, then you must do one of the following things: uninstall Sandcastle and then reinstall it after you install the Visual Studio 2008 SDK, or manually reset the PATH and DXROOT environment variable values.

If you are installing on an x86 machine, you are done. Otherwise, continue to the next section..

To configure an AMD64 machine for Sandcastle

  1. From the Start menu, right-click on My Computer and select Properties.
  2. In the left pane, Click the Advanced System Settings link.
  3. Click the Environment Variables button.
  4. Select the PATH variable, and click Edit.
  5. Add the following text to the Variable Value box, and click OK: ;%ProgramFiles(x86)%\HTML Help Workshop;%ProgramFiles(x86)%\Common Files\Microsoft Shared\Help 2.0 Compiler

See Also

Other Resources
Sandcastle Overview

Last edited Mar 22, 2009 at 9:15 PM by aram, version 1


Dolot Jul 19, 2010 at 9:48 PM 
How does one uninstall an earlier version of sandcastle? I installed VS 2005 sdk in order to get the help stuff, and got sandcastle with it, but there's no way to uninstall just sandcastle. I have to uninstall the entire sdk.