documentation - 为 SandcaSTLe MS Help Viewer 输出指定根容器

Question

我正在使用 SandcaSTLe Help File Builder 为 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 输出是那个节点的 child ？

Answer 1

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

1. 确保文档项目有内容布局文档。

2. 创建一个名为 MSHelpViewerRoot.aml 的新概念内容文档在使用概念模板的文档项目中。内容可能如下所示(将 [Guid] 替换为生成的 GUID，将 [My Topic] 替换为您的内容主题):

   <?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>
   

3. 添加MSHelpViewerRoot.aml内容布局文档的概念性内容。

   • 在主题属性 下，指定 [My Topic] SDK作为标题
   • 在主题属性下，选中用作 MS Help Viewer 根容器
   复选框
   • 在索引关键字下，添加一个带有索引的条目K和条款 [My Topic] SDK

生成的配置可能类似于以下内容:

作为最后的说明，除了根节点之外，您可能还需要执行以下操作:

1. 创建 Welcome.aml概念性内容文档
   • 在 <relatedTopics> 中添加指向欢迎文档的链接MSHelpViewerRoot.aml 的元素
   • 设置Welcome.aml作为内容布局设置中的用作默认主题元素
2. 添加 License.aml概念性内容文件