问题标签 [sandcastle]

我正在尝试使用 Sandcastle Help File Builder 为我的应用程序构建文档。我将 Msdn 缓存组件添加到 .shfbproj 文件中，如下所示：

$(MsdnCachePath) 属性的值为：

问题是生成帮助文件后，此缓存文件未在此位置创建。有什么想法为什么不会发生？

我正在尝试使用 Sandcastle Help File Builder 为我的应用程序构建文档。一项要求是我必须指定文档来源，例如：

我在一个单独的文件中定义了@(DocumentationSourceFiles)，如下所示：

然后我将该文件导入到 .shfbproj 文件中，并如上所述使用它。问题是 @(DocumentationSourceFiles) 没有被识别为项目列表，而仅仅是一个字符串。我做错什么了吗？如果我要将 @(DocumentationSourceFiles) 更改为具有单个值的属性，例如：

然后使用：

一切正常。有任何想法吗？

我正在为我们的 C# API 构建文档，其中包含：

1. 当前状态的一般概述和描述为 doc/pdf 文件。
2. 使用 Sandcastle 的 .chm 文件中的类库 API。

问题：

1. 我应该将这两个合并到同一个 .chm 文件中吗？合并它们的好方法是什么？
2. 我需要排除某些类/包。我如何在 SandCastle 中指定它？
3. 它为 VB 代码和 Visual C++ 代码生成文档。我怎样才能改变这个？还是应该离开它，知道我只使用安全代码？
4. 在我的系统上哪里可以找到 HTML Help 2.x Viewer Path？

编辑：

我在方法、字段和类上所做的注释未在文档中生成。

我该怎么办？

我的 .chm 已生成，但我对类、命名空间、字段、成员的注释未生成。

我能做些什么来解决这个问题？

好奇的问题。我正在使用 Microsoft 的 Sandcastle 从我的 C# 代码中的 XML 注释生成文档。我的几个类正在实现已经有注释方法的接口。我宁愿不要在接口方法和公共实现方法中复制文档。我可以使用某种标签从界面“继承”此文档吗？

I'm trying to add the output of a Sandcastle compilation into source control, but Sandcastle has issues trying to output directly into a subversion-controlled directory structure.

So, what I was trying to do is output into a non-controlled directory and then robocopy into the svn-controlled structure. I'd prefer to use /MIR to remove any old files, but the problem is that this causes robocopy to wipe out all the svn property stuff.

So, is there an easy way to use robocopy the way I want, or is there another solution?

如何将沙堡帮助文件构建器项目 (.shfbproj) 添加到 Visual Studio 2008 解决方案？

我正在寻找可以满足此类要求的帮助/文档生成工具：

• 它应该支持 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 的编辑器中将其标记为“如果可能，请制作此单词链接”。在生成过程中，如果存在具有此类名称的类型名称，则每个此类单词都将成为链接。

我知道这些工具：

• Toolsfactory Doc-o-Matic（现在使用）
• Innovasys DocumentX 和 HelpStudio
• ComponentOne 文档帮助

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

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

因此，请分享您对该常见任务的过期时间（我相信它应该是常见的）。

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

我正在使用 SandCastle Help File Builder 1.8.0.1 及其 MAML 内容编辑器。

我想要一个从默认值 1 以外的值开始的有序列表。

10. Some data

11. Other data

我什至尝试了以下方法，但它不起作用，因为它来自 OL 元素的 HTML：

我怎样才能做到这一点？

有人知道我应该在沙堡样式中修改哪些文件吗？

我有一个带有长名称空间的大型项目，例如

使用 Sandcastle 构建命名空间的文档，但是那些长的命名空间确实搞砸了最终 chm 文件中内容窗格的显示。我怎样才能让它Component.Class至少显示在 Treeview 面板中？

和/或可能CompanyName作为根节点展开Product，然后展开到Component，展开到 Component 下的所有命名空间？