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 - https://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.
- 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.
- Begin by compiling the C# file and extracting the /// comments.
csc /t:library /doc:comments.xml test.cs
- This creates not only test.dll, but also comments.xml file that contains the extracted /// comments
- Next, run MRefBuilder:
MRefBuilder test.dll /out:reflection.org
- Transform the output
For building using VS2005 transforms please use the following:
XslTransform /xsl:"..\..\ProductionTransforms\ApplyVSDocModel.xsl" reflection.org /xsl:"..\..\ProductionTransforms\AddFriendlyFilenames.xsl" /out:reflection.xml
**
For building using prototype transforms please use the following:
XslTransform /xsl:..\..\ProductionTransforms\ApplyPrototypeDocModel.xsl reflection.org /xsl:..\..\ProductionTransforms\AddGuidFilenames.xsl /out:reflection.xml
- Generate a topic manifest
XslTransform /xsl:..\..\ProductionTransforms\ReflectionToManifest.xsl reflection.xml /out:manifest. xml
- 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
- 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)
BuildAssembler /config:sandcastle.config manifest.xml
to generate topic files in HTM.
- Generate HTML help project
XslTransform /xsl:..\..\ProductionTransforms\ReflectionToChmProject.xsl reflection.xml /out:Output\test.hhp
- Generate intermediate table of contents
For building using VS2005 transforms please use the following:
XslTransform /xsl:..\..\ProductionTransforms\createvstoc.xsl reflection.xml /out:toc.xml
For building using prototype transforms please use the following:
XslTransform /xsl:..\..\ProductionTransforms\createPrototypetoc.xsl reflection.xml /out:toc.xml
- Generate HTML help project information
XslTransform /xsl:..\..\ProductionTransforms\TocToChmContents.xsl toc.xml /out:Output\test.hhc
XslTransform /xsl:..\..\ProductionTransforms\ReflectionToChmIndex.xsl reflection.xml /out:Output\test.hhk
- Run hhc (HTML Help 1.x Compiler) to generate Chm, hhc compiles the Sandcastle target files into a CHM file.
hhc output\test.hhp
Bugs/Feature Requests:
- Please send you bugs, feature requests, questions and feedback to sandchlp@microsoft.com