Sandcastle和Sandcastle Help File Builder使用说明

软件下载地址：http://www.codeplex.com/Sandcastle

• 安装Sandcastle.msi
• 安装SandcastleBuilderSetup.msi
• SandcastlePath设置为第一步中的安装目录，而不是第二步的安装目录
• 命名空间的注释不能在源代码中标注，需要在Sandcastle Help File Builder中指定（点击"Namespaces"）
• 使用Language选项可输出中文文档(但左边导航栏中的还是英文)
• HelpTitle设置文档标题，HtmlHelpName设置输出文件名称，OutputPath设置输出文件保存的位置
• PresentationStyle选择Prototype
• HelpFileFormat选择帮助文档的格式(Helpe1x:chm, Helper2x:Hxs, Website)
• 特别注意：HtmlHelpName同时作为HTML Help 2 builds中的collection namespace name(并且不运行空格)

HtmlHelp1x和HtmlHelp2x的区别：

1. chm和hxs是microsoft的两种主流的帮助文档格式.后者是前者的代替者.psdk新版,vs2008都是使用后者作为帮助文档.
2. chm的原始文档html制造或者翻译可以使用dreamweaver,而chm的打包(编译)和反编译可以使用微软提供的html help workshop.
3. hxs前部分同上,hxs的反编译工具和编译工具为HxComp,具体可见http://msdn.microsoft.com/en-us/library/bb164592(VS.80).aspx.特别值得注意的是该MSDN的例子是错误的-u和-d的位置搞错了.之后的shouldn't it be有提示.请注意.
4. Hxcomp下载方法:请见:http://www.helixoft.com/vsdocman-faqs/where-can-i-download-hxcomp.exe.html
5. 请注意:一般情况下hxcomp都是位于c:\program files\microsoft help 2.0 SDK\下,而非你的VSHIK 2003(对于vs2003)安装目录.

　
HxComp.exe is Help2 2 compiler from Microsoft. Here are the links where you can download it：
    (参考地址 http://www.helixoft.com/vsdocman-faqs/where-can-i-download-hxcomp.exe.html)

• For VS .NET 2002 it is part of VSHIK 2002 (Visual Studio Help Integration Kit v2.1). [http://www.microsoft.com/downloads/details.aspx?FamilyID=3eaeb657-98dd-4959-b946-9719fec3a3ce&DisplayLang=en]
• For VS .NET 2003 it is part of VSHIK 2003. [http://www.microsoft.com/downloads/details.aspx?FamilyID=ce1b26dc-d6af-42a1-a9a4-88c4eb456d87&DisplayLang=en]
• For VS 2005 it is part of Visual Studio 2005 SDK (formerly the VSIP SDK) which contains the Help 2 SDK. This download requires free registration.[http://msdn.microsoft.com/zh-cn/vsx/default(en-us).aspx]

用Sandcastle和Help Integration Wizard把文档集成到Visual Studio中
    (参考地址 http://www.cnblogs.com/fox23/archive/2008/09/09/using-sandcastle-integrated-help-documents-into-visual-studio.html)

打开HxS 文件的方法
    (参考地址 http://frogleg.mvps.org/helptechnologies/mshelp2/h2conv.html）

• 需要安装Microsoft Help 2.0 SDK(VSHIK2003.exe)。
• 假设hxs文件路径在 D:\doc\Documentation.HxS   执行"C:\Program Files\Microsoft Help 2.0 SDK\hxreg" -n CompileTest -c D:\doc\Documentation.HxS -d myhelp
• 再执行"C:\Program Files\Microsoft Help 2.0 SDK\hxreg" -n CompileTest -i CompileTest -s D:\doc\Documentation.HxS
• 后即可用"C:\Program Files\Common Files\Microsoft Shared\Help\dexplore.exe" /helpcol ms-help://CompileTest查看
• 特别注意：CompileTest这个名称必须是在SandcastleBuilder中设置的HtmlHelpName(取其他名字会在第二步执行hxreg时产生一个error，从而导致文件无法打开)