帮助文件格式的未来方向

Posted 2023-02-18

技术标签:

【中文标题】帮助文件格式的未来方向【英文标题】：The future direction of Help File formats 【发布时间】：2010-09-28 15:45:51 【问题描述】：

看起来 CHM 帮助文件不再是首选的帮助文件格式。

Win帮助 - 过时的

htmlHelp (CHM) - 默认情况下不支持 Vista - 在网络共享上不能很好地工作

帮助 2 (HXS) - 我知道这是在 VS2005+ 中用于显示帮助

基于网络 - 可能很难管理多个版本

在提供来自同一代码库的多个版本的新 (C#) 应用程序中，您会使用哪种帮助文件格式？

我们希望使用 CHM 帮助，但这似乎不是微软希望我们前进的方向。

有人为他们的帮助文件使用 HXS 吗？

感谢反馈

基于lassevk cmets的更新；

HXS 帮助似乎不打算用于普通帮助项目。

【问题讨论】：

【参考方案1】：

究竟是什么让您认为 Windows Vista 上没有默认的 .chm 查看器？（我的电脑上肯定有，我的 Win7 盒子上也有）

您可能会将 .chm 与 .hlp 混淆（微软确实在 vista 中放弃了 .hlp 支持，然后最终在 Windows 更新中恢复了它）

底线：所有 Windows 版本似乎仍支持 .chm 文件，而我所知道的 .chm 文件的唯一真正替代品是 .html

【讨论】：

【参考方案2】：

this.Mode = Modes.Rant;

几乎所有的帮助文件格式都存在巨大的问题，因为制造商（通常是微软对他们中的很多人）似乎不想做的工作不仅仅是稍微足够好供自己使用。

当第 3 方集成时，我无法告诉您有多少次新的 HXS 格式完全破坏了我的 Visual Studio 帮助。你可以说这是第三方安装工具的错，但是很长一段时间没有关于如何做到这一点的文档没有文档，所以他们不得不在逆向工程之间做出选择（并且弄错了） , 有时）或根本不集成。我仍然不知道集成是否有效，但这些天我只是切换 Visual Studio 以使用在线帮助。它大部分都可以工作，而内置帮助总是落到那个只会锁定 Visual Studio 直到它重建帮助文件的进度条，除了它没有因为文件现在已损坏，所以任何时候我点击F1，Visual Studio 只会锁定，除非我多次终止 DEXPLORE 程序。

这最终是如何解决任何问题的，我仍然不知道。

其次，工具需要存在。 CHM 查看器出现在 pre-vista 上，而不是在 Vista 上，但是显示 HXS 所需的工具在 pre-vista 上不存在，但我认为它们在 Vista 上。很好，所以现在我可以选择使用一种需要在用户计算机上自定义安装的格式，或者......错误，另一种需要在其他用户计算机上自定义安装的格式。对。

this.Mode = Modes.JustTicked;

在我工作的地方，我们发布 CHM 文件，以及基于文件的 html 版本，供那些通过网络共享部署应用程序的人使用。至于 Vista，我们还没有看到太多，但 html 版本也可以在那里工作。

我更希望有一个闪亮的帮助文件。

html 版本的一个很好的结果是我们可以链接到我们产品后面的 web 模块中的相同文件。这样，客户只需要一个版本。

我们正在考虑升级我们在工作中使用的工具，因此在我本周的日程安排中，工作时愉快而安静，我将研究它可以产生的各种类型的输出，以及 HXS 等。

编辑：嗯，快速浏览一下帮助和手册的帮助页面，我们使用的产品有this to say about HXS：

Visual Studio 帮助也称为 MS 帮助 2.0。最初，此帮助格式旨在成为 HTML 帮助的继承者。然而，微软随后无限期推迟了它的发布，现在很明显，它永远不会作为普通用户应用程序的帮助格式发布。

请注意，这是一种特殊的帮助格式，仅用于记录为集成到 Visual Studio .NET 中而设计的第三方编程组件。不适合任何其他用途，不能用于应用程序的正常帮助项目！

我猜 HXS 已经完全不在讨论范围内了。

注意：基于网络并不一定意味着您需要一个网络服务器，只是您需要一个网络浏览器。无论您是使用 Web 浏览器组件将其集成到您的应用程序中，还是只是启动用户默认浏览器，这都是您必须做出的选择，但我见过的大多数基于 Web 的帮助输出不需要任何服务器设置。

【讨论】：

也许我们只需要等待 Windows 7 找出他们将在那里做什么。然后，再一次，在 Windows 8 中。...：D【参考方案3】：

对我来说，CHM 仍然是答案。我使用 Codeplex 上提供的 Sandcastle Help File Builder tool 构建 CHM 文件。

对 CHM 可访问性的担忧是有道理的。为了解决这个问题，我非常轻松地制作了一个 CHM 到 Web 的转换器，其中包含一些 IStorage hack、文本搜索和替换以及 XSL 转换。 This page 是一个大约 8 秒自动生成的网站。它在左侧导航中有一个展开/折叠树视图。基于框架（不是非常友好的 URL），但它工作得很好。

【讨论】：

【参考方案4】：

我见过的唯一有用的帮助文档是纯 HTML。我见过的大多数（如果不是全部）开源项目都有 HTML 帮助页面（用于 API 和参考文档）。使用专有格式或需要专有阅读器的任何内容都存在过时 (CHM) 或存在兼容性或膨胀问题 (PDF) 的风险。

出于某种原因，微软在帮助文件方面表现不佳。 Visual Studio/SQL Studio/Office 的在线帮助很糟糕，MSDN 很乱，CHM 很笨拙，而且 Microsoft 搜索永远不会返回您真正想要的结果。（只是我的看法：）

【讨论】：

CHM 只是被索引和压缩的 HTML。有开源查看器和（解）压缩器【参考方案5】：

对于仍在阅读此问题的任何人的一些更新想法...

根据***，微软在放弃帮助 2 后决定使用Microsoft Assistance Markup Language。

还有 Microsoft Help System，这是 Visual Studio 2010 附带的。

【讨论】：

【参考方案6】：

Adobe RoboHelp 可用于创作具有内容/索引/搜索/词汇表的帮助内容，并且可以在浏览器中以 HTML 生成的方式工作。支持 35 种语言。