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

Question

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

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

理想的情况下，潜在的解决方案：

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

我将继续前进，并将其作为一个维基，并从几个例子开始。如果你有经验，请投票给他们，并留下一些评论。添加其他工具。

Answer 1

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

• 比所见即所得更好了HTML：新结构化
• 输出到QtHelp（除其他事项外），所以会很容易地在我们的应用程序分发（和整合）。
• 不确定本地化，但我们会在需要的时候穿过那座桥。
• 很容易设置和“正常工作”;看起来专业。

Answer 2

Robohelp

Answer 3

Help & Manual

Answer 4

我所知道的唯一一个是Latex，latex2html转换器之一，然后进行了一些改编，以便为CHM归档器准备html。

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

这个档案有一堆中药真实性这种方式（特别是前卫，参考和用户部分，其余的（RTL，整箱，拼箱）是由我们自己的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/

Answer 5

我已经使用的RoboHelp多年。

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

我们正在向狂妄的火炬http://www.madcapsoftware.com/products/flare/robohelp.aspx

Answer 6

我认为DocBook地址，你的要求可能除了同步挂钩，我会觉得有点进一步上。它本质上是为创建文档而设计的XML的一个子集，并且是免费且开源的。它只是一种格式和一组XSL输出转换，可将Docbook转换为更有用的格式（HTML，因此可通过XML-FO或Tex进行CHM，JavaHelp，PDF）。

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

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

一个相当不错的introduction to Docbook可以发现here。

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

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