共用方式為


HelpInfo XML 結構描述

本主題包含可更新的說明資訊檔案的 XML 架構,通常稱為「HelpInfo XML 檔案」。

HelpInfo XML 結構描述

HelpInfo XML 檔案是以下列 XML 架構為基礎。

<?xml version="1.0" encoding="utf-8"?>
<schema 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>

HelpInfo XML 元素

HelpInfo XML 檔案包含下列元素。

  • HelpContentURI -包含模組的說明 CAB 檔案位置的 URI。 URI 的開頭必須是 "HTTP" 或 "HTTPs"。 URI 應該指定網際網路位置,但不能包含 CAB 檔案名。 HelpContentURI 值可以與 HelpInfoURI 值相同或不同。

  • SupportedUICultures -表示所有 UI 文化特性中的模組說明檔。 包含 UICulture 專案,每個元素都代表指定之 UI 文化特性中模組的一組說明檔。

  • UICulture -以指定的 UI 文化特性表示模組的一組說明檔。 針對寫入說明檔的每個 UI 文化特性新增 UICulture 元素。

  • UICultureName -包含用來寫入說明檔之 UI 文化特性的語言代碼。

  • UICultureVersion - Contains a 4-part version number in "N1.N2.N3.N4" format that represents the version of the help CAB file in the UI culture. 每當您以 UICultureName 指定的 UI 文化特性上傳新的說明 CAB 檔案時,就會遞增此版本號碼。 如需此值的詳細資訊,請參閱 版本類別