Documentation 为Sandcastle MS帮助查看器输出指定根容器

Documentation 为Sandcastle MS帮助查看器输出指定根容器,documentation,sandcastle,shfb,help-viewer,Documentation,Sandcastle,Shfb,Help Viewer,我正在使用Sandcastle帮助文件生成器为SDK创建完善的文档。为了支持Visual Studio的F1功能,其中一个输出是MS Help Viewer格式。问题是,当我们将该包安装到Help Viewer 1.0(Visual Studio 2010)或Help Viewer 2.0(Visual Studio 2012)中时,文档没有放在根容器中 图中显示的“API引用”节点是类库本身的容器。虽然我们可以重命名此节点,但这样做不会为我们留下任何位置,以便在类库引用之外包含概念性内容。将

我正在使用Sandcastle帮助文件生成器为SDK创建完善的文档。为了支持Visual Studio的F1功能,其中一个输出是MS Help Viewer格式。问题是,当我们将该包安装到Help Viewer 1.0(Visual Studio 2010)或Help Viewer 2.0(Visual Studio 2012)中时,文档没有放在根容器中

图中显示的“API引用”节点是类库本身的容器。虽然我们可以重命名此节点,但这样做不会为我们留下任何位置,以便在类库引用之外包含概念性内容。将其与.NET Framework 4帮助中等效节点的位置进行比较


问题:为了与其他文档保持一致,我们如何让Sandcastle Help File Builder使用当前的“API参考”在用户指定的顶级容器中为我们的项目生成MS Help Viewer输出类库文档是否是该节点的子节点?

根节点实际上被指定为概念内容文档

  • 确保文档项目具有内容布局文档
  • 使用概念模板在文档项目中创建名为
    MSHelpViewerRoot.aml
    的新概念内容文档。内容可以是这样的(用生成的Guid替换
    [Guid]
    ,用内容主题替换
    [My Topic]
    ):

    
    欢迎使用[我的主题]参考资料
    从目录中选择一个主题。
    
  • MSHelpViewerRoot.aml
    概念性内容添加到内容布局文档中

    • 主题属性下,指定
      [My Topic]SDK
      作为标题
    • 在主题属性下,选中用作MS帮助查看器根容器的复选框
    • 在索引关键字下,添加一个带有索引的条目
  • 生成的配置可能类似于以下内容:

    最后,除根节点外,您可能还需要执行以下操作:

  • 创建
    Welcome.aml
    概念性内容文档
    • MSHelpViewerRoot.aml
    • Welcome.aml
      设置为内容布局设置中的用作默认主题元素
  • 添加
    许可证.aml
    概念内容文档
  • <?xml version="1.0" encoding="utf-8"?>
    <topic id="[Guid]" revisionNumber="1">
      <developerConceptualDocument
          xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
          xmlns:xlink="http://www.w3.org/1999/xlink">
    
        <introduction>
          <para>Welcome to the [My Topic] Reference</para>
        </introduction>
    
        <section>
          <content>
            <para>Select a topic from the table of contents.</para>
          </content>
        </section>
    
        <relatedTopics/>
      </developerConceptualDocument>
    </topic>