Omówienie aktualizowalnej pomocy

Ten dokument zawiera podstawowe wprowadzenie do projektowania i działania funkcji Pomocy z możliwością aktualizowania programu PowerShell. Jest ona przeznaczona dla autorów modułów i innych osób, które dostarczają program Windows PowerShell, ułatwiają tematy użytkownikom.

Wprowadzenie

Tematy pomocy programu PowerShell są integralną częścią środowiska programu PowerShell. Podobnie jak moduły programu PowerShell, tematy pomocy są stale aktualizowane i ulepszane przez autorów oraz przez współtworzenie społeczności użytkowników programu PowerShell.

Funkcja Aktualizowalna pomoc, wprowadzona w programie Windows PowerShell 3.0, zapewnia, że użytkownicy mają najnowsze wersje tematów pomocy w wierszu polecenia, nawet w przypadku wbudowanych poleceń programu PowerShell, bez pobierania nowych modułów lub uruchamiania usługi Windows Update. Aktualizowalna pomoc sprawia, że aktualizacja jest prosta, udostępniając polecenia cmdlet, które pobierają najnowsze wersje tematów pomocy z Internetu i instalują je w odpowiednich podkatalogach na komputerze lokalnym użytkownika. Nawet użytkownicy, którzy znajdują się za zaporami, mogą korzystać z nowych poleceń cmdlet, aby uzyskać zaktualizowaną pomoc z wewnętrznego udziału plików.

Aktualizowalna pomoc jest w pełni obsługiwana przez wszystkie moduły programu Windows PowerShell w systemach Windows 8 i Windows Server 2012, a jego funkcje są dostępne dla wszystkich autorów modułów programu Windows PowerShell. Aktualizowalna pomoc obsługuje tylko pliki pomocy opartej na formacie XML. Nie obsługuje pomocy opartej na komentarzach.

Pomoc aktualizowalna zawiera następujące funkcje.

• Polecenie cmdlet Update-Help, które określa, czy użytkownicy mają najnowsze pliki pomocy dla modułu, a jeśli nie, pobiera najnowsze pliki pomocy z Internetu, rozpakuje je i instaluje je w odpowiednich podkatalogach modułu na komputerze użytkownika. Użytkownicy mogą używać polecenia cmdlet Get-Help, aby natychmiast wyświetlić nowo zainstalowane tematy pomocy. Nie muszą ponownie uruchamiać programu PowerShell.

• Polecenie cmdlet Save-Help, które pobiera najnowsze pliki pomocy z Internetu i zapisuje je w katalogu systemu plików. Użytkownicy mogą użyć polecenia cmdlet Update-Help, aby uzyskać pliki pomocy z katalogu systemu plików i rozpakować je i zainstalować w podkatalogach modułu na komputerze użytkownika. Polecenie cmdlet Save-Help jest przeznaczone dla użytkowników, którzy mają ograniczony lub żaden dostęp do Internetu oraz dla przedsiębiorstw, które wolą ograniczyć dostęp do Internetu.

• Pomoc dotycząca modułu. Pliki pomocy dla modułu są zarządzane i dostarczane jako jednostka, dzięki czemu użytkownicy mogą uzyskać wszystkie pliki pomocy dla używanych modułów. Pomoc aktualizowalna jest obsługiwana tylko w przypadku modułów, a nie w przypadku przystawek programu Windows PowerShell.

• obsługa wersji . Pomoc aktualizowalna używa standardowej czwórki (N1. N2. N3. Numery wersji N4). Aktualizowalna pomoc pobiera pliki pomocy, gdy numer wersji plików pomocy na komputerze użytkownika (lub w katalogu Save-Help) jest niższy niż numer wersji plików pomocy w lokalizacji internetowej.

• obsługa wielu języków. Aktualizowalna pomoc obsługuje pliki pomocy modułu w wielu kulturach interfejsu użytkownika. Możliwe do zaktualizowania nazwy plików Pomocy obejmują standardowe kody języków, takie jak "en-US" i "ja-JP" oraz polecenia cmdlet Update-Help i Save-Help umieszczają pliki pomocy w podkatalogach specyficznych dla języka katalogu modułu.

• Automatycznie wygenerowana pomoc. Polecenie cmdlet Get-Help wyświetla podstawową pomoc dotyczącą poleceń, które nie mają plików pomocy. Automatycznie wygenerowana pomoc obejmuje składnię poleceń i aliasy oraz instrukcje dotyczące korzystania z pomocy online i aktualizowalnej pomocy.

• Ulepszona pomoc online. Łatwy dostęp do pomocy online nie wymaga już plików pomocy. Parametr Online polecenia cmdlet Get-Help teraz pobiera adres URL tematu pomocy online z wartości właściwości HelpUri dowolnego polecenia, jeśli nie może znaleźć adresu URL pomocy online w pliku pomocy. Możesz wypełnić właściwość HelpUri, dodając atrybut HelpUri do kodu poleceń cmdlet, funkcji i poleceń CIM lub używając .LINK słowa kluczowego pomocy opartej na komentarzach w przepływach pracy i skryptach.

  Aby pliki pomocy można było aktualizować, moduły programu Windows PowerShell w systemie Windows nie są dostarczane z plikami pomocy. Użytkownicy mogą użyć aktualizowalnej pomocy, aby zainstalować pliki pomocy i je zaktualizować. Autorzy innych modułów mogą dołączać pliki pomocy do modułów lub pomijać je. Obsługa aktualizowalnej pomocy jest opcjonalna, ale zalecana.