ค้นหาเว็บไซต์

HelpInfo XML Schema


หัวข้อนี้ประกอบด้วย XML schema สำหรับไฟล์ข้อมูลวิธีใช้ที่อัปเดตได้ ซึ่งรู้จักกันทั่วไปในชื่อ "ไฟล์ HelpInfo XML"

HelpInfo XML Schema

ไฟล์ HelpInfo XML จะขึ้นอยู่กับ XML Schema ต่อไปนี้

<?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 - ประกอบด้วย URI ของตำแหน่งของไฟล์ CAB วิธีใช้สำหรับโมดูล URI ต้องขึ้นต้นด้วย "http" หรือ "https" URI ควรระบุตำแหน่งอินเทอร์เน็ต แต่ต้องไม่รวมชื่อไฟล์ CAB ค่า HelpContentURI สามารถเหมือนหรือแตกต่างจากค่า HelpInfoURI ได้

  • SupportedUICultures - แสดงถึงไฟล์วิธีใช้ของโมดูลในวัฒนธรรม UI ทั้งหมด ประกอบด้วยองค์ประกอบ UICulture ซึ่งแต่ละองค์ประกอบแสดงถึงชุดของไฟล์วิธีใช้สำหรับโมดูลในวัฒนธรรม UI ที่ระบุ

  • UICulture - แสดงถึงชุดของไฟล์วิธีใช้สำหรับโมดูลในวัฒนธรรม UI ที่ระบุ เพิ่มองค์ประกอบ UICulture สำหรับแต่ละวัฒนธรรม UI ที่ใช้เขียนไฟล์วิธีใช้

  • UICultureName - มีรหัสภาษาสำหรับวัฒนธรรม UI ที่ใช้เขียนไฟล์วิธีใช้

  • UICultureVersion - ประกอบด้วยหมายเลขเวอร์ชัน 4 ส่วนในรูปแบบ "N1.N2.N3.N4" ที่แสดงถึงเวอร์ชันของไฟล์ CAB ช่วยเหลือในวัฒนธรรม UI เพิ่มหมายเลขเวอร์ชันนี้ทุกครั้งที่คุณอัปโหลดไฟล์ CAB วิธีใช้ใหม่ในวัฒนธรรม UI ที่ระบุโดย UICultureName สำหรับข้อมูลเพิ่มเติมเกี่ยวกับค่านี้ โปรดดูที่คลาสเวอร์ชัน

บันทึก

การเขียนวิธีใช้ XML ด้วยตนเองเป็นเรื่องยากมาก โมดูล PlatyPS ช่วยให้คุณสามารถเขียนความช่วยเหลือใน Markdown แล้วแปลงเป็นความช่วยเหลือแบบ XML ทำให้เขียนและดูแลรักษาความช่วยเหลือได้ง่ายขึ้นมาก PlatyPS ยังสามารถสร้างแพ็คเกจความช่วยเหลือที่อัปเดตได้ให้กับคุณอีกด้วย สำหรับข้อมูลเพิ่มเติม โปรดดูสร้างวิธีใช้แบบ XML โดยใช้ PlatyPS

บทความที่เกี่ยวข้อง