Creating a Chm build using Sandcastle

Here are the steps to create a Chm build using Sandcastle. Please see the atatchment for the steps in text format.

 

Prerequisites:

1.    .Net Framework 2.0

2.    For Chm generation download HTML Help Workshop - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

 

 

How do Reference Build From /// Comments using Sandcastle V2.0:

Sandcastle can read authored triple-slash comments embedded in source files.

 

1. Sandcastle by default is installed at c:/Program files/Sandcastle. Open a command prompt and type the following:

 

cd /Program Files/Sandcastle/Examples/Sandcastle

 

In this directory, you will find only a single C# file called test.cs under Examples/sandcastle directory.

 

2. Begin by compiling the C# file and extracting the /// comments.

csc /t:library /doc:comments.xml test.cs

 

3. This creates not only test.dll, but also comments.xml file that contains the extracted /// comments

 

4. Next, run MRefBuilder:

MRefBuilder test.dll /out:reflection.org

 

5. Transform the output

XslTransform /xsl:../../ProductionTransforms/AddOverloads.xsl reflection.org /xsl:../../ProductionTransforms/AddGuidFilenames.xsl /out:reflection.xml

 

6. Generate a topic manifest

XslTransform /xsl:../../ProductionTransforms/ReflectionToManifest.xsl reflection.xml /out:manifest. xml

 

7. Create an output directory structure

For building using VS2005 transforms please use the following:

call ../../Presentation/vs2005/copyOutput.bat

For building using prototype transforms please use the following:

call ../../Presentation/Prototype/copyOutput.bat

 

 

8. Run BuildAssembler using the sandcastle component stack (Note: We are providing VS 2005 transforms under Presentation/VS2005 folder and the transforms shipped with the previous versions under Presentation/Prototype folder. For building VS2005 format please use sandcastle.config file from C:/Program Files/Sandcastle/Presentation/vs2005/Configuration folder as it uses shared content from C:/Program Files/Sandcastle/Presentation/vs2005/Content and transforms from C:/Program Files/Sandcastle/Presentation/vs2005/Transforms)

           这里要把sandcastle.config拷贝到当前目录

BuildAssembler /config:sandcastle.config manifest.xml

 

to generate topic files in HTM.

 

9. Generate HTML help project

XslTransform /xsl:../../ProductionTransforms/ReflectionToChmProject.xsl reflection.xml /out:Output/test.hhp

 

10. Generate table of contents for HTML help project

XslTransform /xsl:../../ProductionTransforms/ReflectionToChmContents.xsl reflection.xml /arg:html=Output/html /out:Output/test.hhc

 

11. Generate Index information

XslTransform /xsl:../../ProductionTransforms/ReflectionToChmIndex.xsl reflection.xml /out:Output/test.hhk

 

12. Run hhc (HTML Help 1.x Compiler) to generate Chm, hhc compiles the Sandcastle target files into a CHM file.

         这里要在hhc的目录下执行，建议执行在Html Help Workshop的图形化界面中完成

cd /Program Files/Sandcastle/Examples/Sandcastle/Output

and generate test.chm by typing

hhc test.hhp