帮助文件格式的未来方向

时间:2008-12-29 01:08:21

标签: chm winhelp

CHM帮助文件似乎不再是首选的帮助文件格式。

的WinHelp
  - 过时的

HtmlHelp(CHM)
  - 默认情况下不支持Vista
  - 在网络共享上效果不佳

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

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

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

我们希望使用CHM帮助,但它似乎并不是微软希望我们进入的方向。

是否有人使用HXS作为他们的帮助文件?

反馈赞赏


根据lassevk评论更新;

看起来好像HXS帮助不适用于普通的帮助项目。


6 个答案:

答案 0 :(得分:10)

究竟是什么让你觉得Windows Vista上没有默认的.chm查看器? (我的电脑上肯定有一个,以及我的Win7盒子)

您可能会将.chm与.hlp混淆(Microsoft确实在vista中删除了.hlp支持,然后最终在Windows更新中恢复了它)

底线:所有Windows版本似乎仍然支持.chm文件,而我知道的.chm文件的唯一真正替代方法是.html

答案 1 :(得分:4)

this.Mode = Modes.Rant;

几乎所有的帮助文件格式都存在巨大的问题,因为制造商(通常是微软的很多人)似乎并不想做一份工作而不仅仅是略微足够好供自己使用。

我无法告诉你新的HXS格式在第三方集成时完全隐藏了我的Visual Studio帮助的次数。你可以说这是第三方安装工具的错误,但是很长一段时间都有关于如何做到这一点的没有文档,所以他们必须在逆向工程之间做出选择(并且错误,有时)或根本没有整合。我仍然不知道集成是否有效,但是现在我只是将Visual Studio切换为使用在线帮助。它主要起作用,而内置的帮助总是落到那个只是锁定Visual Studio直到它重建了帮助文件的进度条,除了它没有因为文件现在已经损坏,所以每当我点击它F1,Visual Studio只是锁定,除非我多次杀死DEXPLORE程序。

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

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

this.Mode = Modes.JustTicked;

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

我宁愿有一个闪亮的帮助文件

html版本的一个不错的结果是我们可以链接到跟随我们产品的Web模块中的相同文件。这样,客户只需要一个版本。

我们正在考虑升级我们在工作中使用的工具,以便按照我本周的时间表工作,在工作中保持良好和安静,我将关注它可以生成的各种类型的输出,其中包括HXS。


修改:嗯,快速查看帮助和手册的帮助页面,我们使用的产品有this to say about HXS

  

Visual Studio帮助也称为MS Help 2.0。最初,此帮助格式旨在成为HTML帮助的后续版本。但是,微软随后无限期推迟发布,现在很明显,它永远不会作为普通用户应用程序的帮助格式发布。

     

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

我猜HXS完全不在桌面上。


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

答案 2 :(得分:4)

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

对CHM可访问性的担忧是有效的。为了解决这个问题,我很轻松地制作了一个CHM-to-Web转换器,包括一些IStorage黑客攻击,一个文本搜索和替换,以及一个XSL转换。 This page是一个在大约8秒内自动生成的网站。 它在左侧导航栏上有一个展开/折叠树视图。基于框架(不是非常友好的URL)但它运行良好。

答案 3 :(得分:2)

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

出于某种原因,微软在帮助文件方面表现不佳。 Visual Studio / SQL Studio / Office的在线帮助很糟糕,MSDN很乱,CHM很笨拙,微软的搜索永远不会返回你真正想要的结果。 (只是我的意见:)。

答案 4 :(得分:1)

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

我们有一个基于Flex的网络应用程序,用于管理应用程序的帮助内容。 Flex应用程序及其帮助系统适用于Windows / MacOSX / Linux上的大多数浏览器。

答案 5 :(得分:1)

对于仍在阅读此问题的人来说,还有一些更新的想法...

据维基百科称,微软在放弃帮助2后决定Microsoft Assistance Markup Language

还有Microsoft Help System,这是随Visual Studio 2010提供的。