打包 Visual Studio 帮助文件

  • Jonathan Allen
  • 侯伯薇

2011 年 6 月 15 日

话题:.NETIDE语言 & 开发

如果你为.NET 开发者提供了收费或者开源的类库,那么在其中包含帮助文件会显示出你的专业性。当在公司内部应用程序中重用一些框架的时候,拥有帮助文件也会让我们觉得非常方便。

在最近的一篇文章中,Jeff Braaten 向我们说明了创建 Visual Studio 帮助文件的过程。Visual Studio 2010 RTM 和 SP1 中单独的帮助文件在本质上都是带有特定元标签的 XHTML 文件。在这些元标签中会存放基本的信息,如页面的语言 / 地区、内容表格中的位置、关键词以及对 F1 的支持等等。Jeff 强调,我们可以使用.NET 的 XmlReader 来读取这些页面,因此它们的格式必须与 XHTML Basic 1.1 很好地兼容。

然后这些松散的页面会被组合成为工作簿(book)。每个工作簿会被压缩成 zip 文件,其中会包含所有主题页面以及简单描述工作簿的 XHTML 文件。想要安装以这种方式创建的工作簿,你需要拥有管理员的访问权限。如果不行的话,那么你可以把把 zip 文件和描述文件捆绑到签名的 CAB 文件中。当然,这需要获得签名的证书。

在这个过程的描述中,他没有提到如何通过包管理器——特别是Nuget——来对其进行分发。安装时需要管理员访问权限,或者需要签名的 CAB 文件都有些让人无法接受,毕竟那仅仅是文档。

查看英文原文:Packaging Visual Studio Help Files
.NETIDE语言 & 开发