Omówienie aktualizowalnej pomocy

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

Wprowadzenie

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

Funkcja Aktualizowana 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 ani uruchamiania usługi Windows Update. Aktualizowana pomoc ułatwia aktualizowanie, 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 polecenia cmdlet w celu uzyskania zaktualizowanej pomocy z wewnętrznego udziału plików.

Pomoc z możliwością działania z możliwością działania jest w pełni obsługiwana przez wszystkie moduły Windows PowerShell w programach Windows 8 i Windows Server 2012, a jej funkcje są dostępne dla Windows PowerShell autorów modułów. Pomoc, która jest niezmienna, obsługuje tylko pliki pomocy oparte na formacie XML. Nie obsługuje ona pomocy opartej na komentarzach.

Pomoc, która jest niezmienna, 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, rozpakowuje je i instaluje w odpowiednich podkatalogach modułu na komputerze użytkownika. Użytkownicy mogą użyć polecenia cmdlet Get-Help, aby natychmiast wyświetlić nowo zainstalowane tematy pomocy. Nie trzeba 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 , aby uzyskać pliki pomocy z katalogu systemu plików oraz rozpakować i zainstalować je w podkatalogach modułu Update-Help na komputerze użytkownika. Polecenie cmdlet jest przeznaczone dla użytkowników, którzy mają ograniczony dostęp do Internetu lub nie mają go, oraz dla przedsiębiorstw, które Save-Help wolą ograniczyć dostęp do Internetu.

• Pomoc dla 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 modułów, których używają. Pomoc, która może być dostępna, jest obsługiwana tylko w przypadku modułów, a Windows PowerShell przyciągnięciem.

• Obsługa wersji. Pomoc, dla których można ujednoliwnieć, używa standardowej czterech pozycji (N1. N2. N3. N4) numery wersji. Pomoc dostępna do górę pobiera pliki pomocy, gdy numer wersji plików pomocy na komputerze użytkownika (lub w katalogu) jest mniejszy niż numer wersji plików pomocy w lokalizacji Save-Help internetowej.

• Obsługa wielu języków. Pomoc, która jest niezmienna, obsługuje pliki pomocy modułu w wielu kulturach interfejsu użytkownika. Nazwy plików pomocy, które można włączyć, obejmują standardowe kody języków, takie jak "en-US" i "ja-JP", a polecenia cmdlet i umieszczają pliki pomocy w podkatalogach specyficznych dla języka w katalogu Update-Help Save-Help modułu.

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

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

  Aby pliki pomocy były zawsze dostępne, moduły Windows PowerShell w programie Windows 8 i Windows Server vNext nie są wraz z plikami pomocy. Użytkownicy mogą instalować pliki pomocy i aktualizować je za pomocą aktualizowania Pomocy. Autorzy innych modułów mogą dołączać pliki pomocy do modułów lub je pomijać. Obsługa pomocy zamiejscowej jest opcjonalna, ale zalecana.