打包Visual Studio帮助文件

本文介绍如何为.NET开发者提供的类库创建Visual Studio帮助文件。这些帮助文件采用带有特定元标签的XHTML格式,并被组织成工作簿。文章还讨论了安装工作簿的要求。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

如果你为.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
Visual Studio 2008 组合帮助集合管理器 本主题的总结中列出了您的计算机上安装的帮助集合的名称。如果安装了多个集合,可以更改默认 Visual Studio 2008 组合 帮助集合 (VSCC) 中包含哪些集合。选中要在默认 VSCC 集合中包含的帮助集合的对应复选框,并清除要排除的集合旁的复选 框。 警告 排除默认 VSCC 集合中的帮助集合时一定要谨慎。这可能会阻止您访问所需的文档。请考虑使用筛选器来集中搜索与 您的需要相关的帮助主题。 若要减少找到的重复主题数,可以选择包括正在使用的 Visual Studio 2008 版本的帮助集合,并排除其他版本或其他语言的 多余帮助集合。如果修改默认 VSCC 集合,将会更改帮助索引和搜索列表,还有可能更改帮助目录。 当完成标记和清除帮助集合的对应复选框时,请选择“更新 VSCC”按钮。系统将要求您关闭 Visual Studio 2008 和 Microsoft Document Explorer 的所有实例。重新启动这些程序之一时,VSCC 帮助集合将修改为包含下面选中的帮助集合, 并排除其复选框已被清除的集合。 注意 重新打开 Visual Studio 2008 可能要花费几分钟时间,因为此时它将修改 VSCC 帮助集合。 -------------------------------------------------------------------------------- 可在 VSCC 中包含的集合: Microsoft VSIP Combined Help Collection Microsoft SQL Server 2005 Mobile Edition
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值