Shr*_*ike 11 documentation sandcastle documentation-generation help-authoring
我正在寻找一个满足这些要求的帮助/文档生成工具:
更多细节.我的项目是.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的编辑器中标记为"如果可能的话,使这个单词链接".在生成期间,如果存在具有此类名称的类型名称,则每个这样的单词将成为链接.
我知道这些工具:
Doc-o-Matic支持链接自动创建.真的自动.它尝试为PascalCase中的每个单词创建一个链接 - 非常出色.但它不支持MS Word.Innovasys和ComponentOne的软件不支持自动创建链接.Innovasys的软件不支持MS Word(我不确定100%这个).
我试图在Innovasys和ComponentOne的论坛上提问.到目前为止没有运气.Innovasys的软支持场景就像我一样:在单独的工具中创建概念文档 - HelpStudio,并使用其他工具从源代码生成帮助 - DocumentX.但是没有能力自动创建链接并导入MS Word文件.
所以,请分享你对这个共同任务的过期(我确信它应该是常见的).
请告诉我,如果我没有从英语语法的角度正确解释我的想法,我会再试一次.