NOTE: This is an older version of the MSBuild script for Sandcastle. The latest version is now found at my CodePlex site:
http://www.codeplex.com/Release/ProjectReleases.aspx?ProjectName=MSBuildSandcastle
New in this version:
- Support for Sandcastle September CTP (actually, it is needed)
- Support for Visual Studio 2005-like help files
- Support for Index and Search
- Output directory is configurable (thank you Don Eddleman)
Installation instructions:
- If you haven't already done so, install the Sandcastle September CTP.
The scripts rely on a completly unmodified installation, so don't make
any changes to it (especially not the sandcastle.config file).
- Unzip the contents of Sandcastle.zip to your MSBuild folder (usually c:\Program Files\MSBuild)
- Unzip the contents of SandcastleTest.zip to wherever you like to keep your sample projects.
- Open up the SandcastleTest.sln solution file and build the project.
- 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.
- Cross your fingers, and when the process is finished, look for the Help\SandcastleTest.chm and/or the Help\SandcastleTest.HxS files!
- 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.