HelpInfo-XML-schema

Det här avsnittet innehåller XML-schemat för uppdatabel hjälpinformationsfiler, som ofta kallas "HelpInfo XML-filer".

HelpInfo-XML-schema

HelpInfo XML-filer baseras på följande XML-schema.

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

XML-filen HelpInfo innehåller följande element.

  • HelpContentURI – Innehåller URI:en för platsen för hjälp-CAB-filerna för modulen. URI:en måste börja med "http" eller "https". URI:en ska ange en Internetplats, men får inte innehålla CAB-filnamnet. Värdet för HelpContentURI kan vara samma eller ett annat än värdet för HelpInfoURI.

  • SupportedUIKulturs – Representerar modulhjälpfilerna i alla UI-kulturer. Innehåller UIKultur-element, som var och en representerar en uppsättning hjälpfiler för modulen i en angiven ui-kultur.

  • UICulture – Representerar en uppsättning hjälpfiler för modulen i en angiven ui-kultur. Lägg till ett UIKultur-element för varje UI-kultur där hjälpfilerna skrivs.

  • UICultureName – Innehåller språkkoden för ui-kulturen där hjälpfilerna skrivs.

  • UICultureVersion – Innehåller ett versionsnummer i 4 delar i "N1. N2. N3. N4"-format som representerar versionen av hjälp-CAB-filen i ui-kulturen. Öka versionsnumret när du laddar upp nya hjälp-CAB-filer i UI-kulturen som anges av UICultureName. Mer information om det här värdet finns i Version Class.