我正在寻找可以满足此类要求的帮助/文档生成工具:
- 它应该支持 c# 编译器生成的 xmldoc 注释,或者(甚至更好)直接支持 sandcastle
- 它应该支持导入 MS Word 文档。
- 它应该支持创建从概念文档到源代码生成的参考文档的链接。
- 如果它支持 MS Word 中的概念文档创作,那就太好了
更多细节。我的项目是.NET 的框架/库。它有几个 VS 解决方案,总共有 50 多个 C# 项目。首先,我想从我的项目的源代码中生成帮助(未来的 chm & help2 & help3)。我将该文档称为“参考文档”。沙堡(尤其是使用SCFB) 可以很好地做到这一点。但是(我想这是很常见的情况)我有一些关于框架/库的附加文档。该文档位于 MS Word 文件中(5-10 个文件)。我将该文档称为“概念文档”。我想用概念文档和参考文档(如 MSDN)制作一个可靠的帮助系统。我希望帮助的概念部分包含链接(URL),这些链接引用了来自框架/库的每个 .NET 类型名称的帮助的参考部分。(显然任何帮助系统最终都只是 HTML)。
问题是如何创建这些链接。MS Word 文件对 C# xmldoc 一无所知。Sandcastle 不支持 Word 文件。所以我必须采取一些帮助创作工具(HAT)。到目前为止,我找不到任何适合我的工具。如果有任何帮助,我将不胜感激!
所有工具的绊脚石是链接自动创建。我希望在生成期间自动创建链接(可以在构建服务器上进行)。为什么会自动?因为它允许轻松重命名类型。例如。我在概念文档中有一些文本:“用于访问请求处理上下文使用 XOperationContext 类型的静态属性 Current”。这里 XOperationContext 是一个类型名称。我希望它成为结果帮助系统中 XOperationContext 类规范的链接(URL),而无需付出任何重大努力。我想在 Word 中(可能安装了一些 HAT 的插件)或在 HAT 的编辑器中将其标记为“如果可能,请制作此单词链接”。在生成过程中,如果存在具有此类名称的类型名称,则每个此类单词都将成为链接。
我知道这些工具:
Doc-o-Matic 支持链接自动创建。真正自动。它尝试为 PascalCase 中的每个单词创建一个链接——非常出色。但它不支持 MS Word。Innovasys 和 ComponentOne 的软件不支持自动创建链接。Innovasys 的软件不支持 MS Word(对此我不确定 100%)。
我试图在 Innovasys 和 ComponentOne 的论坛上提问。到目前为止没有运气。Innovasys 的软支持方案和我的一样:在单独的工具 - HelpStudio 中创建概念文档,并使用另一个工具 - DocumentX 从源代码生成帮助。但是无法自动创建链接和导入 MS Word 文件。
因此,请分享您对该常见任务的过期时间(我相信它应该是常见的)。
ps如果我没有从英语语法的角度正确解释我的想法,请告诉我,我会再试一次。