Пример XML-файла HelpInfo

В этом разделе показан пример хорошо сформированного файла сведений справки, известного как "XML-файл HelpInfo". В этом примере файла элементы языка и региональных параметров пользовательского интерфейса упорядочиются в алфавитном порядке по имени языка и региональных параметров пользовательского интерфейса. Алфавитное упорядочение является лучшей практикой, но это не обязательно.

Пример 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>

Замечание

Создание справки на основе XML вручную очень сложно. Модуль PlatyPS позволяет написать справку в Markdown, а затем преобразовать ее в справку на основе XML. Это упрощает запись и обслуживание справки. PlatyPS также можно создать пакеты справки с возможностью обновления. Дополнительные сведения см. в статье Создание XML-справки с помощьюPlatyPS.