ljusberg.se

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:

http://www.codeplex.com/Release/ProjectReleases.aspx?ProjectName=MSBuildSandcastle&ReleaseId=1029 

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 SandcastleTest.zip)

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 Sandcastle.zip to your MSBuild folder (usually c:\Program Files\MSBuild)
  3. Unzip the contents of SandcastleTest.zip 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.

Posted Nov 12 2006, 03:25 PM by anders
Filed under: ,
Powered by Community Server (Non-Commercial Edition), by Telligent Systems