HelpInfo XML Şeması


Bu konu, genellikle "HelpInfo XML dosyaları" olarak bilinen Güncellenebilir Yardım Bilgileri dosyalarına yönelik XML şemasını içerir.

HelpInfo XML Şeması

HelpInfo XML dosyaları aşağıdaki XML şemasını temel alır.

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

YardımBilgisi XML Öğeleri

HelpInfo XML dosyası aşağıdaki öğeleri içerir.

  • HelpContentURI - Modüle ilişkin yardım CAB dosyalarının konumunun URI'sini içerir. URI "http" veya "https" ile başlamalıdır. URI bir internet konumu belirtmeli ancak CAB dosya adını içermemelidir. HelpContentURI değeri, HelpInfoURI değeriyle aynı veya farklı olabilir.

  • SupportedUICultures - Tüm kullanıcı arayüzü kültürlerindeki modül yardım dosyalarını temsil eder. Her biri belirli bir kullanıcı arayüzü kültüründeki modül için bir dizi yardım dosyasını temsil eden UICulture öğelerini içerir.

  • UICulture - Belirli bir kullanıcı arayüzü kültüründeki modüle yönelik bir dizi yardım dosyasını temsil eder. Yardım dosyalarının yazıldığı her kullanıcı arayüzü kültürü için bir UICulture öğesi ekleyin.

  • UICultureName - Yardım dosyalarının yazıldığı kullanıcı arayüzü kültürünün dil kodunu içerir.

  • UICultureVersion - Kullanıcı arayüzü kültüründeki yardım CAB dosyasının sürümünü temsil eden "N1.N2.N3.N4" biçiminde 4 parçalı bir sürüm numarası içerir. UICultureName tarafından belirtilen kullanıcı arayüzü kültürüne yeni yardım CAB dosyaları yüklediğinizde bu sürüm numarasını artırın. Bu değer hakkında daha fazla bilgi için bkz. Sürüm Sınıfı.

Not

XML tabanlı yardımın manuel olarak yazılması çok zordur. PlatyPS modülü, Markdown'da yardım yazmanıza ve ardından bunu XML tabanlı yardıma dönüştürmenize olanak tanır. Bu, yardım yazmayı ve sürdürmeyi çok daha kolaylaştırır. PlatyPS ayrıca sizin için Güncellenebilir Yardım paketleri de oluşturabilir. Daha fazla bilgi için PlatyPS kullanarak XML tabanlı yardım oluşturma konusuna bakın.

İlgili makaleler