Web 帮助(英语:Web Help),又称基于浏览器的帮助,是一种在线帮助系统。它是未编译的 HTML 帮助文件,一个帮助项目的所有文件都包含在一个文件夹里(可能包含成千上百个文件),其中包括一组 HTML 文件(所有帮助主题文件)、图片、音频文件及控制文件等。将 Web Help 上传到 Web 服务器或局域网中某个共享文件夹,就可以使用普通浏览器进行访问(例如 IE、Mozilla Firefox、Opera、Apple Safari 等)。Web Help 也可以在电脑硬盘上本地运行。Web Help 包含目录和关键词索引,方便用户浏览使用。[1][2]
Web Help 可以通过所有主流浏览器访问,也是唯一可以在浏览器上运行的帮助格式。如果为基于 Web 的软件程序创建帮助文件,Web Help 是最佳选择。[1]

文件格式

编辑

简单的 Web Help 可能由一套网页文件组成。较为复杂的 Web Help 还包括一个框架集侧边栏,提供目录和搜索功能,跟 HTML 帮助文件相似。

有多种工具可用于创建 Web Help。例如:DocBook XSL, HelpSmith, MadCap Flare, Adobe RoboHelp, WebWorks ePublisher, Macrobject Word-2-Web, XDocs Knowledgebase, Help & Manual, chm2web, FAR HTML, HelpMapper, SuiteHelp, Author-it, Help Explorer Server 等。

优势

编辑

Web Help 的优势在于:

  1. 允许内容持续更新。
  2. 可以为潜在购买者提供更加详细的产品信息。
  3. Web Help 可以通过普通网页浏览器(IE、Firefox 等)访问,也可以在几乎所有主流平台上(Windows、Mac、Linux、UNIX 等)运行,因此是一个跨平台解决方案。[2]而本地在线帮助只能通过帮助查看器运行,且通常只能在特定平台运行。
  4. 如果使用 DocBook XSL 系统,则可以采用单源发布将技术文档或其它类型文档(如产品手册)输出为 PDF 格式用于印刷、HTML 格式用于在线发布、以及输出 Web Help 格式通过光盘传播。

劣势

编辑
  1. Web Help 最大的劣势在于,如果只提供在线访问,那么用户访问帮助文件必须依赖于网络连接。
  2. 通过 Web Help 有效地实现上下文关联帮助是很困难的。不过大多数工具已为此提供了解决方案,使提供上下文关联的 Web Help 变成可能。例如,使用 HelpSmith、MadCap Flare、RoboHelp 等工具创建的 Web Help 系统支持很多 URL 参数,这些参数可用于跟 Web 或桌面应用相集成。
  3. Web Help 是未编译的、开放性的帮助文件,用户可能更改主题文件(提供本地访问的文件)的内容。这是一个潜在风险。[2]

外部链接

编辑

参考文献

编辑
  1. 1.0 1.1 How to Create a Web Help System. HelpSmith. [2018-07-09]. 
  2. 2.0 2.1 2.2 Neil Perlin. HTML Help vs. WebHelp. [2018-07-09].