如何向提供商帮助主题添加“另请参阅”部分

笔记

手动编写基于 XML 的帮助非常困难。 PlatyPS 模块允许您在 Markdown 中编写帮助，然后将其转换为基于 XML 的帮助。这使得编写和维护帮助变得更加容易。 PlatyPS 还可以为您创建可更新的帮助包。有关详细信息，请参阅使用 PlatyPS 创建基于 XML 的帮助。

本节介绍如何填充提供商帮助主题的另请参阅部分。

另请参见部分包含与提供程序相关或可能帮助用户更好地理解和使用提供程序的主题列表。主题列表可以包括 Windows PowerShell 中的 cmdlet 帮助、提供程序帮助和概念性（“关于”）帮助主题。它还可以包括对书籍、论文和在线主题的引用，包括当前提供商帮助主题的在线版本。

当您引用在线主题时，请以纯文本形式提供 URI 或搜索词。 Get-Help cmdlet 不会链接或重定向到列表中的任何主题。此外，Get-Help cmdlet 的 Online 参数不适用于提供程序帮助。

另请参阅部分是根据RelatedLinks元素及其包含的标签创建的。以下 XML 显示了如何添加标签。

添加另请参阅主题

1. 在 <AssemblyName>.dll-help.xml 文件的 providerHelp 元素中，添加 RelatedLinks 元素。 RelatedLinks 元素应该是 providerHelp 元素中的最后一个元素。每个提供程序帮助主题中只允许有一个 RelatedLinks 元素。

   例如：

   <providerHelp>
       <RelatedLinks>
       </RelatedLinks>
   </providerHelp>
   

2. 对于另请参阅部分中的每个主题，在RelatedLinks元素中添加一个navigationLink元素。然后，在每个 navigationLink 元素中添加一个 linkText 元素和一个 uri 元素。如果您不使用 uri 元素，则可以将其添加为空元素 ()。

   例如：

   <providerHelp>
       <RelatedLinks>
           <navigationLink>
               <linkText> </linkText>
               <uri> </uri>
           </navigationLink>
       </RelatedLinks>
   </providerHelp>
   

3. 在 linkText 标记之间键入主题名称。如果您要提供 URI，请在 uri 标记之间键入它。要指示当前提供商帮助主题的在线版本，请在 linkText 标记之间键入“在线版本：”而不是主题名称。通常，“在线版本：”链接是“另请参阅”主题列表中的第一个主题。

   以下示例包括三个“另见”主题。第一个参考当前主题的在线版本。第二个引用 Windows PowerShell cmdlet 帮助主题。第三个是指另一个网上话题。

   <providerHelp>
       <RelatedLinks>
           <navigationLink>
               <linkText> Online version: </linkText>
               <uri>http://www.fabrikam.com/help/myFunction.htm</uri>
           </navigationLink>
           <navigationLink>
               <linkText> about_functions </linkText>
               <uri/>
           </navigationLink>
           <navigationLink>
               <linkText> Windows PowerShell Getting Started Guide </linkText>
               <uri>https://go.microsoft.com/fwlink/?LinkID=89597<uri/>
           </navigationLink>
       </RelatedLinks>
   </providerHelp>