wysiwyg用户帮助创作工具与qthelp一起使用?

时间:2011-03-25 18:46:34

标签: qt wysiwyg help-authoring

我们需要编译为 QtHelp (。qch和.qhc)。我想知道什么工具/工具链最容易做到这一点?我们想要一个WYSIWYG帮助创作工具作为我们的起点,然后通过我们必须的任何方式运行输出以获得QtHelp。

我们使用了帮助&手动过去,这就是我们在帮助创作工具中寻找的那种WYSIWYG界面。但我们需要工具链来生成简单的html页面(每个帮助主题一个),我们可以使用qhelpgeneratorqcollectiongenerator,以及创建.qhp(至少是目录和关键字) ())和.qhcp生成.qch和.qhc。我没有看到如何帮助&手册可以适应这一点。

我们简要介绍了 Sphynx ,但似乎文字格式的选项非常有限。例如,它看起来没有任何方法可以更改文本部分的字体,字体大小,字体颜色等。看起来实际上不可能有粗体和斜体的文字。看起来很适合开发人员文档,但似乎缺少用于创作用户帮助文件的基本内容。如果我以某种方式错过了基本的文本格式化功能,请纠正我!

那么,你推荐什么WYSIWYG帮助创作工具,从该工具到.qch和.qhc的路径是什么?

3 个答案:

答案 0 :(得分:0)

毕竟看起来帮助和手册会起作用!这是我们现在正在看的序列。如果您发现任何问题或改进,请发表评论。

在帮助&手动(使用版本5.5.1 Build 1296专业版许可证测试),在Project Explorer中的Configuration部分:

转到HTML页面模板\默认。在“HTML源代码”选项卡中,注释掉该部分。

转到发布选项\ Web帮助。

在布局中,选择无框架,无脚本。

在导航中,我们不需要检查任何东西 - 虽然如果有办法控制KEYWORD_INDEX值的格式,那么我们可以直接复制并粘贴到我们的.qhp中,这太棒了!我还没有办法做到这一点,所以我们计划直接在.qhp。

中维护关键字

同样,目录也无关紧要,除非我们能够控制我们必须直接在.qhp中维护toc的格式。

在弹出主题中,我们设置为HTML编码主题。不确定是否有必要。

这就是我们必须改变的所有设置。正常情况下在H& M中创建帮助内容,然后发布Webhelp。这会为每个主题创建一个单独的.htm文件。

在与.htm相同的文件夹中,我们创建.qhp和.qhcp文件,然后运行qcollectiongenerator来生成我们的.qhc,然后我们用Qt Assistant显示它。有关此工具链的Qt方面的帮助,请参阅http://doc.qt.nokia.com/4.7/qthelp-framework.html

同样,如果我们能找到一种方法来设置H& M以创建.qhp所需格式的toc和关键字,我们可以将它们粘贴到.qhp(或者用于重要的是,也要在该模板中维护.qhp)。另一种选择是编写一个脚本,将H& M为toc和关键字创建的内容转换为.qhp所需的内容。如果您这样做并且不介意分享,请发布代码!

我们发现使用H& M解决此问题的一些好处:

  • 多个文档可以同时工作,源代码在Subversion中存储为文本文件,因此它是可版本化的,您可以比较更改。
  • 轻松WYSIWYG创建帮助主题
  • 可以处理各种文本格式和链接。例如,在功能的端到端测试中,看看H& M的哪些功能在我们的最终产品中有效(在Qt助手中查看.qhc),我很惊讶地看到Qt Assistant甚至在图像链接中处理热点到其他主题/主题。
  • .qhc已集成到Qt中,因此您可以在Qt应用程序中很好地控制您的帮助。

同样,如果有人对此有更好的解决方案或改进,请发帖!

答案 1 :(得分:0)

使用Helpinator 3 Professional它生成chm qt javahelp word pdf文件很容易..

答案 2 :(得分:0)

您可以考虑 HelpNDoc 帮助创作工具,它具有所见即所得的编辑器并且可以generate Qt Help files 开箱即用。生成的源文件可以选择保留以供手动编辑和手动编译。