in

ljusberg.se

Browse Folders

Sandcastle MSBuild script

Downloads: 2,361 File Size: 4.6kB
Posted By: anders Views: 4,390
Date Added: 2006-09-16

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:

  1. Support for Sandcastle September CTP (actually, it is needed)
  2. Support for Visual Studio 2005-like help files
  3. Support for Index and Search
  4. Output directory is configurable (thank you Don Eddleman)

Installation instructions:

  1. 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).
  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.

Filed under: ,

Comments

 

David L. Pruett said:

I am stuck on item 5. I cannot locate any of the builds. Thank you.
2007-06-01 15:53
 

David L.Pruett said:

Build found but now when building (step 5) I get error message stating that Files missing from C: ProgramFiles\Sandcastle\ProductionTransforms\AddOverload.xsl could not be found. I then went to http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en to get the latest Sandcastle - but this did not help. Any suggestions greatly appreciated. Thank you.
2007-06-01 17:05
 

anders said:

Did you use the build script here (which is old) or the new one at: http://www.codeplex.com/MSBuildSandcastle /Anders
2007-06-02 16:55
 

Gayan Denzil said:

Hey, I am completely new to Sandcastle, And I am trying to integration sandcastle through msbuild scripts into our daily builds. I find it very difficult to locate any helpful source to continue my work. I actually feel this is a mess, why MS did not provide a good help. I am going to try out what you have provided. I will keep you posted. Cheers! Dena
2008-11-13 9:17
 

Gayan Denzil said:

I encountered the same thing as David L.Pruett did. Error says "ProductionTransforms\AddOverloads.xsl" and "ProductionTransforms\AddGUIDFilenames.xsl" exited with code 1. The 2 files can not be found in the specified location. Do you know why? Regards, Dena
2008-11-13 10:19

Add Comment

(required) 
(required)
(optional)
(required) 
Add
Powered by Community Server (Non-Commercial Edition), by Telligent Systems