标签: help-authoring

Robohelp的任何免费替代品？喜欢开源

需要某种开源项目的在线帮助创作工具.

我正在寻找一个满足这些要求的帮助/文档生成工具:

• 它应该支持c#编译器生成的xmldoc注释或者(甚至更好)直接支持sandcastle
• 它应该支持导入MS Word文档.
• 它应该支持创建从概念文档到源代码生成的参考文档的链接.
• 如果它支持MS Word中的概念性文档创作,那就太好了

更多细节.我的项目是.NET的框架/库.它有几个VS解决方案,共有超过50个C#项目.首先,我想从我的项目的源代码生成帮助(将来chm&help2&help3).我将该文档称为"参考文档".Sandcastle(特别是使用SCFB)可以非常好的方式做到这一点.但是(我想这是非常常见的情况)我有一些框架/库的附加文档.该文档是在MS Word文件(5-10文件)中.我将该文档称为"概念文档".我想用概念文档和参考文档(如MSDN)生成一个可靠的帮助系统.我希望帮助的概念部分包含链接(URL),它引用框架/库中每个.NET类型名称的帮助的引用部分.(显然,任何帮助系统最终都只是HTML).

问题是如何创建这些链接.MS Word文件对C#xmldoc一无所知.Sandcastle不支持Word文件.所以我必须采取一些帮助创作工具(HAT).到目前为止,我找不到任何不适合我的工具.如果有任何帮助,我将非常感谢!

所有工具的绊脚石都是链接自动创建.我想在生成期间自动创建链接(可以在构建服务器上进行).为何自动？因为它允许轻松重命名类型.例如.我在概念文档中有一些文本:"用于访问请求处理上下文使用静态属性Current of XOperationContext type".这里XOperationContext是一个类型名称.我希望它成为XOperationContext类在结果帮助系统中的规范的链接(URL),没有任何重大的努力.我想在Word中标记它(可能安装了一些HAT的插件),或者在HAT的编辑器中标记为"如果可能的话,使这个单词链接".在生成期间,如果存在具有此类名称的类型名称,则每个这样的单词将成为链接.

我知道这些工具:

• Toolsfactory Doc-o-Matic(现在使用)
• Innovasys DocumentX和HelpStudio
• ComponentOne Doc-to-Help

Doc-o-Matic支持链接自动创建.真的自动.它尝试为PascalCase中的每个单词创建一个链接 - 非常出色.但它不支持MS Word.Innovasys和ComponentOne的软件不支持自动创建链接.Innovasys的软件不支持MS Word(我不确定100%这个).

我试图在Innovasys和ComponentOne的论坛上提问.到目前为止没有运气.Innovasys的软支持场景就像我一样:在单独的工具中创建概念文档 - HelpStudio,并使用其他工具从源代码生成帮助 - DocumentX.但是没有能力自动创建链接并导入MS Word文件.

所以,请分享你对这个共同任务的过期(我确信它应该是常见的).

请告诉我,如果我没有从英语语法的角度正确解释我的想法,我会再试一次.

有哪些好的创作工具可以为最终用户创建跨平台的帮助文件？(我们的应用程序使用Qt框架,如果这有任何区别.)

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

理想情况下,解决方案是:

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

我将继续并将其作为维基,并从几个例子开始.如果你有经验,可以投票或者投票,并留下一些评论.还添加其他工具.

我在HTML帮助研讨会中创建了一个项目.当我打开帮助(/ chm)应用程序时,我可以看到目录.默认情况下,选择文件中的第一个条目,但是我看不到相应的页面数据,而是能够看到"此程序无法显示网页"(IE7中出现的默认错误消息).页面显示只有当我点击左侧的任何内容时.

有没有办法默认显示页面而不点击该条目？

谢谢Rupa

这个问题说的都是真的.如果您正在编写WPF应用程序,那么如何集成应用程序帮助？2013年中期的比赛状态如何？

从搜索引擎的下午开始,似乎没有明确的答案,但有几种选择:

1. 编写自己喜欢的基于工具提示的帮助(但是从哪里获取数据？)

2. 使用.CHM文件和Windows窗体帮助系统(对我来说似乎很古老).

3. 使用Microsoft Help Viewer 1.X或Microsoft Help 2.0.

   • 关于MS最近/批准哪些内容存在一些混淆.看起来帮助查看器1.X可能是Microsoft Help 2.0的推荐选项.这些名字如此相似并没有帮助......
   • 2.0的状态是什么？我们应该使用它吗？是否曾全面部署？

4. 使用第三方产品编写您的帮助文件并以某种方式链接到它们 - DocToHelp/NetHelp,NetAdvantage在线帮助等...

此外,您使用什么基于XAML的标记/属性来提供必要的上下文？推荐的方法是什么？

令人惊讶的是,在WPF中支持基于应用程序的帮助没有明确的途径.