Wednesday, October 17, 2007

Generating Documentation with Sandcastle

The following apps are required to get going with Sandcastle:

  • XP Service Pack 2
  • .NET 2.0
  • HTML Help Workshop
  • Microsoft Sandcastle
  • Sandcastle Help File Builder

First, ensure you have HTML Help Workshop by checking for the existence of the following folder:

C:\Program Files\HTML Help Workshop

If it is not there or does not contain hhc.exe, then download and install it from the following URL:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

Microsoft Sandcastle can be found from here:

http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

Sandcastle Help File Builder can be found here:

http://www.codeplex.com/SHFB

You should also download the Presentation File Patches from the URL above and extract them into the Sandcastle folder.

Now you should run BuildReflectionData.bat in Sandcastle root directory to build reflection data for the .NET runtime.

Now launch Sandcastle Help File Builder and get going...