documentation - 具有 MS Word 和 C# xmldoc 支持的帮助生成工具

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

3年前关闭。




Improve this question




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

它应该支持由 c# 编译器生成的 xmldoc 注释或者(甚至更好)直接支持 SandcaSTLe

它应该支持导入 MS Word 文档。

它应该支持创建从概念文档到从源代码生成的引用文档的链接。

如果它支持 MS Word 中的概念文档创作，那就太好了

更多细节。
我的项目是 .NET 的框架/库。它有几个 VS 解决方案，总共有 50 多个 C# 项目。首先，我想从我的项目的源代码中生成帮助( future 的 chm & help2 & help3)。我将该文档称为“引用文档”。 SandcaSTLe(尤其是使用 SCFB )可以以非常好的方式做到这一点。
但是(我想这是很常见的情况)我有一些关于框架/库的额外文档。该文档位于 MS Word 文件(5-10 个文件)中。我将该文档称为“概念文档”。
我想用概念文档和引用文档(如 MSDN)生成一个可靠的帮助系统。
我希望帮助的概念部分包含链接 (URL)，这些链接 (URL) 引用框架/库中每个 .NET 类型名称的帮助引用部分。 (显然，任何帮助系统最终都只是 HTML)。

问题是如何创建这些链接。 MS Word 文件对 C# xmldoc 一无所知。 SandcaSTLe 不支持 Word 文件。所以我必须采取一些帮助创作工具(HAT)。
目前我找不到任何适合我的工具。如有任何帮助，我将不胜感激!

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

我知道这些工具:

Toolsfactory Doc-o-Matic (现在使用)

Innovasys DocumentX and HelpStudio

ComponentOne Doc-to-Help

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

我试着在 Innovasys 和 ComponentOne 的论坛上提问。到目前为止没有运气。
Innovasys 的软支持方案与我的类似:在单独的工具 HelpStudio 中创建概念文档，并使用另一个工具 DocumentX 从源代码生成帮助。但是没有自动创建链接和导入 MS Word 文件的能力。

因此，请分享您对该常见任务的到期时间(我确定它应该是常见的)。

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

Answer 1

如何将您的 MS Word 文件导出为 HTML，然后将它们合并到帮助文件的 HTML 中？这是一个选择吗？可能会丢失一些格式，但它可能会让您更好地集成所有内容。