HelpInfo XML Sample File (Ficheiro de Exemplo XML HelpInfo)

Este tópico exibe um exemplo de um arquivo de Informações de Ajuda atualizável bem formado, comumente conhecido como "arquivo XML HelpInfo". Neste arquivo de exemplo, os elementos de cultura da interface do usuário são organizados em ordem alfabética pelo nome da cultura da interface do usuário. A ordenação alfabética é uma prática recomendada, mas não é obrigatória.

HelpInfo XML Sample File (Ficheiro de Exemplo XML HelpInfo)

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

Observação

A criação manual de ajuda baseada em XML é muito difícil. O módulo PlatyPS permite escrever ajuda em Markdown e, em seguida, convertê-la em ajuda baseada em XML. Isso torna muito mais fácil escrever e manter a ajuda. PlatyPS também pode criar os pacotes de Ajuda atualizáveis para você. Para obter mais informações, consulte Ajuda para criar base em XML usando o PlatyPS.