帮助信息 XML 架构

本主题包含可更新帮助信息文件（通常称为“HelpInfo XML 文件”）的 XML 架构。

帮助信息 XML 架构

HelpInfo XML 文件基于以下 XML 架构。

<?xml version="1.0" encoding="utf-8"?>
<schema elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/powershell/help/2010/05" xmlns="http://www.w3.org/2001/XMLSchema">
  <element name="HelpInfo">
    <complexType>
      <sequence>
        <element name="HelpContentURI" type="anyURI" minOccurs="1" maxOccurs="1" />
        <element name="SupportedUICultures" minOccurs="1" maxOccurs="1">
          <complexType>
            <sequence>
              <element name="UICulture" minOccurs="1" maxOccurs="unbounded">
                <complexType>
                  <sequence>
                    <element name="UICultureName" type="language" minOccurs="1" maxOccurs="1" />
                    <element name="UICultureVersion" type="string" minOccurs="1" maxOccurs="1" />
                  </sequence>
                </complexType>
              </element>
            </sequence>
          </complexType>
        </element>
      </sequence>
    </complexType>
  </element>
</schema>

帮助信息 XML 元素

HelpInfo XML 文件包含以下元素。

• HelpContentURI - 包含模块的帮助 CAB 文件位置的 URI。 URI 必须以“http”或“https”开头。 URI 应指定 Internet 位置，但不得包含 CAB 文件名。 HelpContentURI 值可以与 HelpInfoURI 值相同或不同。

• SupportedUICultures - 表示所有 UI 区域性中的模块帮助文件。包含 UICulture 元素，每个元素代表指定 UI 区域性中模块的一组帮助文件。

• UICulture - 表示指定 UI 区域性中模块的一组帮助文件。为编写帮助文件的每个 UI 区域性添加一个 UICulture 元素。

• UICultureName - 包含编写帮助文件的 UI 区域性的语言代码。

• UICultureVersion - 包含“N1.N2.N3.N4”格式的 4 部分版本号，表示 UI 区域性中帮助 CAB 文件的版本。每当您在 UICultureName 指定的 UI 区域性中上传新的帮助 CAB 文件时，都会增加此版本号。有关此值的更多信息，请参阅版本类。

笔记

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