8

有哪些优秀的创作工具可以为最终用户创建跨平台帮助文件？（我们的应用程序使用的是 Qt 框架，如果这有什么不同的话。）

注意：我对内部 API 文档不感兴趣——我们为此使用了doxygen。

理想情况下，解决方案将：

  • 允许我们在一个位置管理所有帮助内容（文本、目录、图像等）。
  • 输出为本机帮助格式。（Windows 的 CHM ——或者至少我们可以直接输入 HTML 帮助 API 的东西；不确定其他平台的“标准”帮助格式是什么。）
  • 体面的所见即所得支持：轻松处理常见的文本输入、图像、交叉引用等，但我们可以在需要时编辑 HTML。
  • 帮助项目（XML 等）的基于文本的文件格式，以便它可以在 Subversion 中进行版本控制。
  • 任何有助于使其与实际代码库保持同步的钩子都会很棒。（也许帮助主题以某种方式与代码文件相关联，并且可以检查 Subversion 以查看是否进行了任何更改并将主题标记为“可能已过时”......我在做梦吗？）
  • 帮助内容可以本地化。
  • 不反对商业产品，但免费的选择会很好。

我会继续把它变成一个wiki，并从几个例子开始。如果您对他们有经验，请对他们投赞成票或反对票，并留下一些评论。还要添加其他工具。

4

6 回答 6

4

我刚刚发现了狮身人面像；我想我恋爱了。

  • 比 HTML 上的 WYSIWYG 更好：reStructuredText
  • 输出到 QtHelp（除其他外），因此很容易在我们的应用程序中分发（和集成）。
  • 还不确定本地化，但我们会在需要时跨过那座桥。
  • 易于设置并且“正常工作”；看起来很专业。
于 2010-06-09T13:52:51.003 回答
2

我已经使用 robohelp 多年了。

很好，但核心技术现在很老了。他们锁定到 Word 版本的方式也是一个完整的 PITA（并迫使我多次避免 MS Office 升级）。

我们正在转向 madcap 耀斑http://www.madcapsoftware.com/products/flare/robohelp.aspx

于 2010-08-30T00:20:42.427 回答
2

我认为DocBook可以满足您的所有要求，除了同步钩子，我会进一步思考。它本质上是为创建文档而设计的 XML 子集，并且是免费和开源的。它只是一种格式加上一组 XSL 输出转换，可将 Docbook 转换为更有用的格式（HTML 以及 CHM、JavaHelp、通过 XML-FO 或 Tex 的 PDF）。

这意味着您仍然需要选择一个 XML 创作工具来实际编辑它，这样所见即所得的东西将取决于您的 XML 创作软件的功能。我们使用 Syntext Serna，因为它对 WYSIWYG 和 XML #includes 的内联编辑有很好的支持（似乎没有其他人支持后者）。您可能会发现其他 XML 创作工具更适合您的需要 - Serna 是一种价格合理的商业产品。

Docbook 通过分析提供了很大的灵活性，它允许您根据属性包含/排除 xml 元素。示例用例是 OS=Windows 的帮助输出与 OS=Linux 的帮助输出略有不同。通过分析和其他机制也支持本地化。

可以在此处找到对 Docbook的相当好的介绍。

我们使用 Docbook 作为我们的帮助格式，并将其编译为 CHM 文件，其中仅包含与特定产品相关的功能的帮助（即企业版具有标准版或演示版中没有的功能）。相关步骤如下：

  1. 在 XML 源上运行 Profiling XSL 模板（使用例如 XSLTproc）。
  2. 在 1 的输出上运行 HTML-Help XSL 模板。
  3. 使用 Microsoft 的 HTML 帮助编译器 (HHC) 编译输出 HTML 文件。
于 2010-08-30T01:35:16.807 回答
1

帮助和手册

于 2010-06-04T20:05:26.743 回答
0

机器人帮助

于 2010-06-04T20:04:33.283 回答
0

我知道的唯一一个是 Latex，它是 latex2html 转换器之一，然后进行了一些修改以使生成的 html 为 CHM 存档器准备好。

  • text,html,chm,pdf,ps没问题。
  • 通过 RTF 转换为 Word 曾经是一场灾难，不知道当前状态。
  • latex 2 html 转换器，虽然有几个，但都有自己的问题。
  • pdf 看起来非常棒。
  • 所见即所得（通过 lyx）可能。

这个档案有一堆 CHM（特别是 prog、ref 和 user 部分，其余部分（rtl、fcl、lcl）由我们自己的 doxygen 等价物 fpdoc 生成）

http://www.stack.nl/~marcov/doc-chm.zip

请注意，上述 CHM 是使用我们自己的（便携式）CHM 编译器制作的。是的，没有更多的研讨会。

PDF 和 html 格式的 Lyx 文档：

pdf： http: //www.stack.nl/~marcov/buildfaq.pdf

html: http://www.stack.nl/~marcov/buildfaq/

于 2010-06-11T11:31:29.630 回答