Udostępnij za pomocą


Przykładowy plik XML HelpInfo

W tym temacie przedstawiono przykład dobrze sformułowanego pliku Updatable Help Information, powszechnie znanego jako "Plik XML HelpInfo". W tym przykładowym pliku elementy kultury interfejsu użytkownika są uporządkowane w kolejności alfabetycznej według nazwy kultury interfejsu użytkownika. Porządkowanie alfabetyczne jest najlepszym rozwiązaniem, ale nie jest wymagane.

Przykładowy plik 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>

Uwaga / Notatka

Ręczne tworzenie pomocy opartej na języku XML jest bardzo trudne. Moduł PlatyPS umożliwia napisanie pomocy w języku Markdown, a następnie przekonwertowanie go na pomoc opartą na języku XML. Ułatwia to pisanie i konserwację pomocy. platyPS można również utworzyć pakiety Pomocy z możliwością aktualizacji. Aby uzyskać więcej informacji, zobacz Create XML-based help using PlatyPS.