MSBuild script support for the November CTP

Anand has released yet a new version of the Sandcastle CTP. The November CTP has a couple of fixes and includes support for friendly HTM file names.

I've updated the MSBuild script for Sandcastle with this support and I have also moved into my new CodePlex site.

So, the download is now found at: 

New in this version:

  1. Support for Sandcastle November CTP
  2. In your Documentation.proj-file, you can now add an entry specifying that you want to use Friendly HTM-file names. (See the sample Documentation.proj file in

Installation instructions:

  1. If you haven't already done so, install the Sandcastle November CTP.
    The scripts rely on a completly unmodified installation, so don't make
    any changes to it (especially not the sandcastle.config file).
  2. Unzip the contents of to your MSBuild folder (usually c:\Program Files\MSBuild)
  3. Unzip the contents of to wherever you like to keep your sample projects.
  4. Open up the SandcastleTest.sln solution file and build the project.
  5. Open a Visual Studio 2005 Command prompt, navigate to the SandcastleTest folder and run the one of the following commands:
    • MSBuild Documentation.proj
      To build both a CHM and an HxS file
    • MSBuild Documentation.proj /t:DocumentationNew
      To build an HxS file.
    • MSBuild Documentation.proj /t:Documentation
      To build a CHM file.
  6. Cross your fingers, and when the process is finished, look for the Help\SandcastleTest.chm and/or the Help\SandcastleTest.HxS files!
  7. In order to actually view an HxS-file you'll need to register it with MSHelp. Or, an easier way (just to see that it works) is to use the free H2Viewer-utility.

2 responses to “MSBuild script support for the November CTP”

  1. I would like to use the msBuild script in French, I’m not sure where to modify the script to make it work. Any help will be appreciate.



  2. There is no target DocumentationNew in the targets file, it is DocumentationHelp2. It is also good to note that you have to have either Visual Studio 2005 SDK or Microsoft Help 2.0 SDK to create HxS files


Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

About Me

Consultant, Solution Architect, Developer.

Do note that this blog is very, very old. Please consider that before you follow any of the advice in here!


%d bloggers like this: