问题标签 [maml]

在工作中，我们使用 Sandcastle 来创建帮助文件。我使用 SandCastleGUI 已经有一段时间了，我正在寻找一种在帮助文件中创建其他页面的方法。这些页面以称为 MAML 的 XML 格式编写。唯一的问题是我找不到适合这些文件格式的任何合适的编辑器。

我正在寻找一个所见即所得的编辑器来创建和编辑其他文档页面。

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

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

10. Some data

11. Other data

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

我怎样才能做到这一点？

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

我正在开发一个新库，并且我正在使用 XML 注释作为 API 文档以及运行良好的 SandCastle。

但我需要编写额外的文档，涵盖概念、整体架构、工作演示等、类图等。

我有两个选择：

1. 使用一些 wiki 引擎并编写文档 wiki 样式。
2. 使用似乎是为此目的的 MAML。

使用 wiki 似乎是安全的解决方案，因为有许多稳定、流行和免费的引擎可用，但 API 和概念文档不会齐头并进（交叉链接、外观等）。使用 MAML 意味着一个学习曲线，我不确定它有多成熟以及它的优点/缺点是什么。

您是否为此目的使用过 MAML/Wiki，您学到了什么？你会建议我什么？

有谁知道用于生成 PowerShell cmdlet 帮助文件的实用程序？手动操作似乎有点乏味...

我找到了：http: //blogs.msdn.com/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx

有更新版本吗？我无法选择模块。我有一个二进制模块。

我正在生成与 Powershell 的 Get-Help cmdlet 一起使用的 MAML 文件。我想验证它们。谁能告诉我是否有可以验证的架构文件？

我正在使用 Sandcastle 帮助文件生成器，并希望在“概念内容”中包含彩色 HTML 代码片段。这可能吗？如果可以，怎么做？

我尝试过 <code>、<codeExample> 和 <sampleCode language="HTML" />。

到目前为止，最好的结果是对示例 HTML 进行 HTML 编码，并将其放在 .snippets 文件中，如下所示。

然后在 .aml 文件中引用它。

我更希望将其着色，但我无法找到添加格式的方法。

当我在我的文档中引用一个方法时，我会这样写：M:MyClass.MyMethod(System.String)

如果我需要引用扩展方法，我该怎么做？

我正在为我们在 Sandcastle 制作的其他技术文档编写一些概念文档。

那里没有很多好的示例/链接，但我开始掌握 MAML 的窍门。如果有人有任何优秀的资源来查看/理解这一点，我将不胜感激。

我希望我的概念文档能够引用我的文档源中的某些类型。有没有办法把像“>类型”这样简单的东西链接到代码中的文档？

编辑：这是我的一个主要问题，因为我是新手。

链接到代码项的最佳方式是从实体窗口中获取它。要打开实体窗口，请转到窗口 > 实体引用。从这里，您可以找到适当的类型/方法/属性并将其从结果中拖到代码中。

MAML 参考指南包含在 Sandcastle Styles 下载中：http : //sandcastlestyles.codeplex.com/ 并且在学习如何格式化事物方面非常有帮助。

我在我的 Sandcastle 项目中添加了一个 test.aml 文件，其中 BuildAction 为 None。

我还添加了一个 Content Layout.content 文件并将 test.aml 添加到布局中。当我构建帮助（仅限网站格式）时，主题包含在 TOC 中，但内容不存在。当我单击该主题时，没有任何反应，它仍保留在上一个主题上。

我是否遗漏了什么，或者这是 SHFB 的已知问题/限制？

我正在使用 SHFB 的 v1.9.4.0。

我正在尝试创建一个不（必然）包含任何反映代码部分的帮助系统。使用最新的 Sandcastle 帮助文件生成器，是否可以只包含 MAML XML 文件，所以需要更改什么设置，因为目前我得到了

错误 BE0042：您必须以程序集或 Visual Studio 解决方案/项目文件的形式指定至少一个文档源。