Share via

Jak utworzyć plik XML HelpInfo

  • Artykuł

W tym temacie w tej sekcji wyjaśniono, jak utworzyć i wypełnić plik z informacjami o pomocy, powszechnie znany jako "plik XML HelpInfo" dla funkcji Pomocy, która może być uzupełniana w programie PowerShell.

Plik XML HelpInfo — omówienie

Plik XML HelpInfo jest podstawowym źródłem informacji o pomocy dla modułu, które można ujednolić. Zawiera on lokalizację plików pomocy dla modułów, obsługiwane kultury interfejsu użytkownika oraz numery wersji używane przez pomoc do ujednonoliwienia w celu określenia, czy użytkownik ma najnowsze pliki pomocy.

Każdy moduł ma tylko jeden plik XML HelpInfo, nawet jeśli moduł zawiera wiele plików pomocy dla wielu kultur interfejsu użytkownika. Autor modułu tworzy plik XML HelpInfo i umieszcza go w lokalizacji internetowej określonej przez klucz HelpInfoUri w manifeście modułu. Gdy pliki pomocy modułu zostaną zaktualizowane i przekazane, autor modułu aktualizuje plik XML HelpInfo i zastępuje oryginalny plik XML HelpInfo nową wersją.

Bardzo ważne jest, aby plik XML HelpInfo był starannie utrzymywany. Jeśli przekażemy nowe pliki, ale zapomnimy o inkrementacjach numerów wersji, pomoc nie będzie pobierać nowych plików na komputery użytkowników. Jeśli dodasz pliki pomocy dla nowej kultury interfejsu użytkownika, ale nie zaktualizujemy pliku XML HelpInfo ani nie umieszczasz go we właściwej lokalizacji, Pomoc aktualizowana nie pobierze nowych plików.

W tej sekcji

Ta sekcja zawiera następujące tematy.

Zobacz też

Obsługa aktualizowalnej pomocy