跨平台的最终用户帮助创作工具

Question

为最终用户创建跨平台帮助文件有哪些好的创作工具？ （我们的应用程序使用的是Qt框架，如果这有任何区别的话。）

注意：我对内部API文档不感兴趣 - 我们正在使用doxygen。

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

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

我会继续把它变成一个wiki并从一些例子开始。如果你有经验，可以投票或者投票，并留下一些评论。还添加其他工具。

Answer 1

我刚发现Sphinx;我想我爱上了。

• 优于WYSIWYG而不是HTML：reStructuredText
• 输出到QtHelp（以及其他内容），因此很容易在我们的应用程序中分发（和集成）。
• 还不确定本地化，但我们会在需要时跨过那座桥。
• 很容易设置和“正常工作”;看起来很专业。

Answer 2

我多年来一直使用过robohelp。

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

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

Answer 3

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

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

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

可以找到相当不错的introduction to Docbook here。

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

1. 在XML Source上运行Profiling XSL模板（使用例如XSLTproc）。
2. 在输出1上运行HTML-Help XSL模板。
3. 使用Microsoft的HTML帮助编译器（HHC）编译输出HTML文件。

Answer 4

Help & Manual

Answer 5

Robohelp

Answer 6

我唯一知道的是Latex，其中一个为latex2html转换器，然后进行了一些调整以使得生成的html为CHM归档器做好准备。

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

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

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

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

Lyx文档为PDF和html：

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

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