跨平台终端用户帮助编写工具

8

有哪些适用于创建面向最终用户的跨平台帮助文件的良好作者工具?(我们的应用程序正在使用Qt框架,如果这有任何区别的话。)

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

理想情况下,解决方案应该:

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

我将把这篇文章变成维基,并提供一些例子。如果您有使用经验,请投票表决,留下评论。也请添加其他工具。

6个回答

4

我刚刚发现了Sphinx,我觉得我爱上它了。

  • 比WYSIWYG编辑HTML更好:使用reStructuredText语法
  • 可以输出到QtHelp(等等),因此在我们的应用程序中易于分发(和集成)。
  • 对于本地化还不确定,但需要时我们会解决。
  • 很容易安装和使用,看起来很专业。

2

2
我认为DocBook除了可能需要更深入地考虑同步钩子外,它已经满足了您的所有需求。它本质上是XML的一个子集,专门用于创建文档,并且是免费且开源的。它只是一个格式加上一组XSL输出转换,将Docbook转换为更有用的格式(HTML以及CHM、JavaHelp、通过XML-FO或Tex生成的PDF)。
这意味着您仍然需要选择一个XML编辑工具来实际编辑它,因此WYSIWYG等功能取决于您的XML作者软件的功能。我们使用Syntext Serna,因为它对WYSIWYG和XML #includes的内联编辑有很好的支持(似乎没有其他人支持后者)。您可能会发现其他XML作者工具更适合您的需求,Serna是一个价格合理的商业提供。
通过分析,Docbook提供了很多灵活性,可以根据其属性包含/排除xml元素。示例用例是为OS = Windows和OS = Linux提供略有不同的帮助输出。本地化也通过分析和其他机制得到支持。
一份相当不错的Docbook简介可以在这里找到。
我们使用Docbook来制作帮助文档,并将其编译成CHM文件,仅包含与特定产品相关的功能(例如企业版具有标准版或演示版中没有的功能)。 相关步骤如下:
  1. 对XML源代码运行分析XSL模板(例如XSLTproc)。
  2. 对第1步的输出运行HTML-Help XSL模板。
  3. 使用Microsoft的HTML Help Compiler(HHC)编译输出的HTML文件。


0

0

我知道的唯一一个是Latex,其中之一是latex2html转换器,然后进行一些适应性调整,使生成的HTML准备好CHM存档。

  • 文本、HTML、CHM、PDF、PS都没有问题。
  • 通过RTF转换为Word曾经是一场灾难,不知道当前状态。
  • 虽然有几个latex 2 html转换器,但它们都有自己的问题。
  • PDF看起来绝对棒极了。
  • WYSIWYM(通过lyx)是可能的。

这个存档有一堆那样的CHMs(特别是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/

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接