HelpInfo-XML-voorbeeldbestand

In dit onderwerp wordt een voorbeeld weergegeven van een goed opgemaakt Help-informatiebestand dat kan worden bijgewerkt, ook wel 'HelpInfo XML-bestand' genoemd. In dit voorbeeldbestand worden de elementen van de UI-cultuur in alfabetische volgorde gerangschikt op de naam van de UI-cultuur. Alfabetische volgorde is een best practice, maar dit is niet vereist.

HelpInfo-XML-voorbeeldbestand

<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
   <HelpContentURI>https://go.microsoft.com/fwlink/?LinkID=141553</HelpContentURI>
   <SupportedUICultures>
    <UICulture>
      <UICultureName>de-DE</UICultureName>
      <UICultureVersion>2.15.0.10</UICultureVersion>
    </UICulture>
    <UICulture>
      <UICultureName>en-US</UICultureName>
      <UICultureVersion>3.2.0.7</UICultureVersion>
    </UICulture>
    <UICulture>
      <UICultureName>it-IT</UICultureName>
      <UICultureVersion>1.1.0.5</UICultureVersion>
    </UICulture>
    <UICulture>
      <UICultureName>ja-JP</UICultureName>
      <UICultureVersion>3.2.0.4</UICultureVersion>
    </UICulture>
   </SupportedUICultures>
</HelpInfo>

Opmerking

Handmatig schrijven van hulp op basis van XML is erg moeilijk. Met de module PlatyPS kunt u hulp schrijven in Markdown en deze vervolgens converteren naar op XML gebaseerde help. Hierdoor is het veel eenvoudiger om hulp te schrijven en te onderhouden. PlatyPS- kunt ook de Updateable Help-pakketten voor u maken. Zie Hulp op basis van XML maken met PlatyPS-voor meer informatie.